ccdoc SPMDataStream ../fmutl/SPMDataStream.h:166:class

FemtoScan Online SDK Documentation

class SPMDataStream

? ^

extends SPMVar as public
extends FSAxesContainer as public

Data stream implementation.
Based on SPMVar class. Variable should have array type. Stream contains list of alternate axes (for converting data to real values), vector of SPMDataStream::dimension structures, offset value, which is used to mark particular block position in the bigger chunk of data, and list of variables, which it depends on. Stream entities should be transferred over network sequentially and processed by stream handler. Stream can contain all the data needed for the representation, or just part of it. But dimension information should be enough to build the container, and the missing data can be set to 0 initially.

Source:
../fmutl/SPMDataStream.h:166

Author:
ATC

Version:
1.0

See Also:
SPMDataStream::dimension

Entity Type Scope Short Description

~SPMDataStream destructor public Standart destructor.

SPMDataStream constructor public Standart constructor.

SPMDataStream constructor public Copy constructor.

add_dependent_var method public Add dependent variable to the list.

axis typedef public undocumented

clear_parsed_options method protected Clear offset and dimensions lists.

dimension class public Dimension implementation.

get_dependent_vars method public Get dependent variables list.

get_dimension method public Get dimension.

get_dimension method public Get dimension.

get_dimensions_number method public Get number of dimensions.

get_offset method public Get offset value.

get_parameter_stream method public Get parameter stream id.

get_subimage_names method public Get subimages names.

has_dependent_var method public Check if variable is a dependency of this stream.

operator = operator public Copy operator.

parsed_options method protected Get options string.

parse_options method protected Retrieve stream parameters from options.

set_dependent_vars method public Set dependent variables list.

set_dependent_vars method public Set dependent variables list.

set_dimension method public Set dimension.

set_offset method public Set offset value.

set_parameter_stream method public Set parameter stream id.

set_subimage_names method public Set subimage names list.

set_subimage_names method public Set subimage names list.

Entity	Type	Scope	Short Description
~SPMDataStream	destructor	public	Standart destructor.
SPMDataStream	constructor	public	Standart constructor.
SPMDataStream	constructor	public	Copy constructor.
add_dependent_var	method	public	Add dependent variable to the list.
axis	typedef	public	undocumented
clear_parsed_options	method	protected	Clear offset and dimensions lists.
dimension	class	public	Dimension implementation.
get_dependent_vars	method	public	Get dependent variables list.
get_dimension	method	public	Get dimension.
get_dimension	method	public	Get dimension.
get_dimensions_number	method	public	Get number of dimensions.
get_offset	method	public	Get offset value.
get_parameter_stream	method	public	Get parameter stream id.
get_subimage_names	method	public	Get subimages names.
has_dependent_var	method	public	Check if variable is a dependency of this stream.
operator =	operator	public	Copy operator.
parsed_options	method	protected	Get options string.
parse_options	method	protected	Retrieve stream parameters from options.
set_dependent_vars	method	public	Set dependent variables list.
set_dependent_vars	method	public	Set dependent variables list.
set_dimension	method	public	Set dimension.
set_offset	method	public	Set offset value.
set_parameter_stream	method	public	Set parameter stream id.
set_subimage_names	method	public	Set subimage names list.
set_subimage_names	method	public	Set subimage names list.

destructor ~SPMDataStream

? ^ >

Standart destructor.

Source:
../fmutl/SPMDataStream.h:251

Code:
public FMUTL_API virtual ~ SPMDataStream ( )

constructor SPMDataStream

? ^ < >

Standart constructor.

Source:
../fmutl/SPMDataStream.h:233

Code:
public FMUTL_API SPMDataStream ( )

constructor SPMDataStream

? ^ < >

Copy constructor.

Source:
../fmutl/SPMDataStream.h:239

Param:

X object to copy.

Code:
public FMUTL_API SPMDataStream ( const SPMDataStream & X )

method add_dependent_var

? ^ < >

Add dependent variable to the list.
If variable with such id already exists, nothing done.

Source:
../fmutl/SPMDataStream.h:321

Param:

id variable's id.

Code:
public FMUTL_API void add_dependent_var ( const char * id )

typedef axis

? ^ < >

undocumented

Source:
../fmutl/SPMDataStream.h:169

Code:
public typedef FSAxis axis

method clear_parsed_options

? ^ < >

Clear offset and dimensions lists.

Source:
../fmutl/SPMDataStream.h:426

Code:
protected virtual void clear_parsed_options ( )

class dimension

? ^ < >

Dimension implementation.
This class is used for dimension description. Dimension has associated length (number of points) and one or more alternate axes.

Source:
../fmutl/SPMDataStream.h:180

Author:
ATC

Version:
1.0

See Also:
SPMDataStream::axis

Code:
public class dimension : public FSAxesContainer

method get_dependent_vars

? ^ < >

Get dependent variables list.

Source:
../fmutl/SPMDataStream.h:300

Params:

strlst pointer to the intialized strings array.

size number of elements in the array

Returns:
if strlst or size is nonzero, number of copyed elements returned. If strlst and size are both 0, returns the number of the elements in the dependent variables list.

Code:
public FMUTL_API unsigned get_dependent_vars ( smart_string * strlst ,
unsigned size ) const

method get_dimension

? ^ < >

Get dimension.

Source:
../fmutl/SPMDataStream.h:266

Param:

i zero-based dimension number.

Returns:
constant reference to the dimension.

Code:
public FMUTL_API const dimension & get_dimension ( unsigned i ) const

method get_dimension

? ^ < >

Get dimension.

Source:
../fmutl/SPMDataStream.h:272

Param:

i zero-based dimension number.

Returns:
reference to the dimension.

Code:
public FMUTL_API dimension & get_dimension ( unsigned i )

method get_dimensions_number

? ^ < >

Get number of dimensions.

Source:
../fmutl/SPMDataStream.h:259

Returns:
number of stream dimensions.

Code:
public FMUTL_API unsigned get_dimensions_number ( ) const

method get_offset

? ^ < >

Get offset value.

Source:
../fmutl/SPMDataStream.h:284

Returns:
offset value.

Code:
public FMUTL_API unsigned get_offset ( ) const

method get_parameter_stream

? ^ < >

Get parameter stream id.

Source:
../fmutl/SPMDataStream.h:364

Returns:
parameter stream id (zero if none).

Code:
public FMUTL_API const char * get_parameter_stream ( ) const

method get_subimage_names

? ^ < >

Get subimages names.

Source:
../fmutl/SPMDataStream.h:338

Params:

strlst pointer to the intialized strings array.

size number of elements in the array

Returns:
if strlst or size is nonzero, number of copyed elements returned. If strlst and size are both 0, returns the number of the elements in the subimage names list.

Code:
public FMUTL_API unsigned get_subimage_names ( smart_string * strlst ,
unsigned size ) const

method has_dependent_var

? ^ < >

Check if variable is a dependency of this stream.

Source:
../fmutl/SPMDataStream.h:328

Param:

id variable's identificator

Returns:
true if id presents in dependent variables list, false otherwise.

Code:
public FMUTL_API bool has_dependent_var ( const char * id ) const

operator =

? ^ < >

Copy operator.

Source:
../fmutl/SPMDataStream.h:246

Param:

X stream to copy.

Returns:
reference to modifyed object (*this).

Code:
public FMUTL_API SPMDataStream & operator = ( const SPMDataStream & X )

method parsed_options

? ^ < >

Get options string.

Source:
../fmutl/SPMDataStream.h:421

Returns:
options string

See Also:
SPMVar::parsed_options

Code:
protected virtual smart_string parsed_options ( unsigned & unused_items ) const

method parse_options

? ^ < >

Retrieve stream parameters from options.
Parameters should have the following form:
 stream,((<axis 1>)[,(<axis 2>)...]),<N dimensions>,(<dimension 1>),...,(<dimension N>)
 [[<stream offset>],[(<dependent variables>)],[(<subimage names>)],
 [parameter stream id],[array data type]]
Axis described as follows:
 <start>,<scale>,(<units>)
start and scale are the real numbers, units is a character string.
N dimensions is an unsigned integer number.
Dimension described as follows:
 <length>,(<axis 1>)[,(<axis 2>)...]
length is an unsigned integer, specifying number of points along given dimension.
stream offset is an integer offset of this stream's data into the main stream data, stored on client or server - this is suitable for transferring chunks of data over network.
dependent variables are listed by their id's, delimited with commas
subimage names has following format:
 (<first subimage name>),(<second subimage name>),...
parameter stream id is the id of an X stream for this (Y) paramatric stream
aray data type is one of the following options:

void
int8
uint8
int16
uint16
int32
uint32
int64
uint64
float32
float64
if array data type is omitted, it has void type. Otherwise, the block size value will be overwritten with the number of bits in type, divided by 8 (byte size).

Source:
../fmutl/SPMDataStream.h:414

See Also:
SPMVar::parse_options

Code:
protected virtual void parse_options ( )

method set_dependent_vars

? ^ < >

Set dependent variables list.

Source:
../fmutl/SPMDataStream.h:307

Params:

strlst pointer to the null-terminated strings array.

size number of elements in the array

Code:
public FMUTL_API void set_dependent_vars ( const char * * strlst ,
unsigned size )

method set_dependent_vars

? ^ < >

Set dependent variables list.

Source:
../fmutl/SPMDataStream.h:314

Params:

strlst pointer to the intialized strings array.

size number of elements in the array

Code:
public FMUTL_API void set_dependent_vars ( const smart_string * strlst ,
unsigned size )

method set_dimension

? ^ < >

Set dimension.

Source:
../fmutl/SPMDataStream.h:278

Param:

i zero-based dimension number. If i is greater or equal to number of dimensions, required number of dimensions and strides will be added.

Code:
public FMUTL_API void set_dimension ( unsigned i ,
const dimension & d )

method set_offset

? ^ < >

Set offset value.

Source:
../fmutl/SPMDataStream.h:290

Param:

offs new offset value.

Code:
public FMUTL_API void set_offset ( unsigned offs )

method set_parameter_stream

? ^ < >

Set parameter stream id.

Source:
../fmutl/SPMDataStream.h:358

Param:

par_stream parameter stream id.

Code:
public FMUTL_API void set_parameter_stream ( const char * par_stream )

method set_subimage_names

? ^ < >

Set subimage names list.

Source:
../fmutl/SPMDataStream.h:345

Params:

strlst pointer to the null-terminated strings array.

size number of elements in the array

Code:
public FMUTL_API void set_subimage_names ( const char * * strlst ,
unsigned size )

method set_subimage_names

? ^ < >

Set subimage names list.

Source:
../fmutl/SPMDataStream.h:352

Params:

strlst pointer to the intialized strings array.

size number of elements in the array

Code:
public FMUTL_API void set_subimage_names ( const smart_string * strlst ,
unsigned size )

strlst	pointer to the intialized strings array.
size	number of elements in the array

public FMUTL_API unsigned get_dependent_vars (	smart_string * strlst ,
	unsigned size ) const

public FMUTL_API unsigned get_subimage_names (	smart_string * strlst ,
	unsigned size ) const

strlst	pointer to the null-terminated strings array.
size	number of elements in the array

public FMUTL_API void set_dependent_vars (	const char * * strlst ,
	unsigned size )

public FMUTL_API void set_dependent_vars (	const smart_string * strlst ,
	unsigned size )

public FMUTL_API void set_dimension (	unsigned i ,
	const dimension & d )

public FMUTL_API void set_subimage_names (	const char * * strlst ,
	unsigned size )

class SPMDataStream

Contents

destructor ~SPMDataStream

constructor SPMDataStream

constructor SPMDataStream

method add_dependent_var

typedef axis

method clear_parsed_options

class dimension

method get_dependent_vars

method get_dimension

method get_dimension

method get_dimensions_number

method get_offset

method get_parameter_stream

method get_subimage_names

method has_dependent_var

operator =

method parsed_options

method parse_options

method set_dependent_vars

method set_dependent_vars

method set_dimension

method set_offset

method set_parameter_stream

method set_subimage_names

method set_subimage_names