FemtoScan Online SDK Documentation

Process implementation.

Based on SPMVar class. Variable should have boolean type. Process contains list of SPMDataStream streams IDs and list of variables IDs, which it strictly depends on. This variables should not be changed, while process is active.

Source:

../fmutl/SPMProcess.h:13

Author:

ATC

Version:

1.0

Entity	Type	Scope	Short Description
~SPMProcess	destructor	public	Standart destructor.
SPMProcess	constructor	public	Standard constructor.
SPMProcess	constructor	public	Copy constructor.
add_stream	method	public	Add stream to the stream list.
clear_parsed_options	method	protected	Clear streams and locked variables lists.
get_locked_vars	method	public	Get locked variables list.
get_streams	method	public	Get stream list.
has_locked_var	method	public	Check if variable is locked.
has_stream	method	public	Check if stream belongs to this process.
operator =	operator	public	Copy operator.
operator =	operator	public	undocumented
parsed_options	method	protected	Get options string.
parse_options	method	protected	Retrieve process parameters from options.
remove_stream	method	public	Remove stream from stream list.
set_locked_vars	method	public	Set locked variables list.
set_streams	method	public	Set stream list.

Standart destructor.

Source:

../fmutl/SPMProcess.h:37

Code:

public FMUTL_API virtual ~ SPMProcess ( )

Standard constructor.

Source:

../fmutl/SPMProcess.h:19

Code:

public FMUTL_API SPMProcess (

)

Copy constructor.

Source:

../fmutl/SPMProcess.h:25

Param:

X	object to copy.

Code:

public FMUTL_API SPMProcess (

const SPMProcess & X )

Add stream to the stream list.

If stream with such id aready exists, nothing done.

Source:

../fmutl/SPMProcess.h:65

Param:

id	steram's identificator

Code:

public FMUTL_API void add_stream (

const char * id )

Clear streams and locked variables lists.

Source:

../fmutl/SPMProcess.h:129

Code:

protected virtual void clear_parsed_options (

)

Get locked variables list.

Source:

../fmutl/SPMProcess.h:89

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 locked variables list.

Code:

public FMUTL_API int get_locked_vars (	smart_string * strlst ,
	int size ) const

Get stream list.

Source:

../fmutl/SPMProcess.h:50

Params:

sl	pointer to the streams id's array.
size	number of elements in the array

Returns:

if sl or size is nonzero, number of copyed elements returned. If sl and size are both 0, returns the number of the elements in the stream list. Each string in sl list must be freed with fmutl_free .

Code:

public FMUTL_API int get_streams (	smart_string * sl ,
	int size ) const

Check if variable is locked.

Source:

../fmutl/SPMProcess.h:103

Param:

id	variable's identificator

Returns:

true if id presents in locked variables list, false otherwise.

Code:

public FMUTL_API bool has_locked_var (

const char * id ) const

Check if stream belongs to this process.

Source:

../fmutl/SPMProcess.h:79

Param:

id	steram's identificator

Returns:

true if id presents in streams list, false otherwise.

Code:

public FMUTL_API bool has_stream (

const char * id ) const

Copy operator.

Source:

../fmutl/SPMProcess.h:32

Param:

X	process to copy.

Returns:

reference to modifyed object (*this).

Code:

public FMUTL_API SPMProcess & operator = (

const SPMProcess & X )

undocumented

Source:

../fmutl/SPMProcess.h:39

Code:

public FMUTL_API bool operator = (

bool X )

Get options string.

Source:

../fmutl/SPMProcess.h:124

Returns:

options string

See Also:

SPMVar::parsed_options

Code:

protected virtual smart_string parsed_options (

unsigned & unused_items ) const

Retrieve process parameters from options.

Parameters should have the following form:

 process,(,...),(,...)

where stream id is a member of process's streams list, and variable id is a meber of process's locked variables list.

Source:

../fmutl/SPMProcess.h:117

See Also:

SPMVar::parse_options

Code:

protected virtual void parse_options (

)

Remove stream from stream list.

If stream with such id exists, it will be removed, otherwise nothing done.

Source:

../fmutl/SPMProcess.h:72

Param:

id	steram's identificator

Code:

public FMUTL_API void remove_stream (

const char * id )

Set locked variables list.

Source:

../fmutl/SPMProcess.h:96

Params:

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

Code:

public FMUTL_API void set_locked_vars (	const char * * strlst ,
	int size )

Set stream list.

Sets new stream list. Previous stream list will be cleared.

Source:

../fmutl/SPMProcess.h:58

Params:

sl	stream list to set.
size	number of elements in the list.

Code:

public FMUTL_API void set_streams (	const std::string * sl ,
	int size )

(C) Advanced Technologies Center, 2002-2006
For support contact us at fsdev@nanoscopy.net