stromx  0.8.0
Public Types | Public Member Functions | List of all members
stromx::runtime::Parameter Class Reference

Description of a parameter. More...

#include <Parameter.h>

Inheritance diagram for stromx::runtime::Parameter:
stromx::runtime::Description stromx::runtime::NumericParameter< runtime::stromx::runtime::Primitive > stromx::runtime::EnumParameter stromx::runtime::MatrixParameter stromx::runtime::NumericParameter< data_t > stromx::runtime::ParameterGroup

Public Types

enum  AccessMode {
  NO_ACCESS, NONE_READ, NONE_WRITE, INITIALIZED_READ,
  INITIALIZED_WRITE, ACTIVATED_WRITE
}
 
- Public Types inherited from stromx::runtime::Description
enum  Type { NO_TYPE, PARAMETER, INPUT, OUTPUT }
 
enum  UpdateBehavior { PERSISTENT, PUSH, PULL, INTERNAL }
 

Public Member Functions

 Parameter (const unsigned int id, const VariantHandle &variant, ParameterGroup *const group=0)
 
AccessMode accessMode () const
 
void setAccessMode (const AccessMode mode)
 
UpdateBehavior updateBehavior () const
 
void setUpdateBehavior (const UpdateBehavior behavior)
 
virtual const Parameter * group () const
 
virtual const std::vector< const Parameter * > & members () const
 
virtual Type originalType () const
 
virtual Type currentType () const
 
- Public Member Functions inherited from stromx::runtime::Description
 Description (const unsigned int id, const VariantHandle &variant)
 
const std::string & title () const
 
unsigned int id () const
 
const VariantHandle & variant () const
 
void setTitle (const std::string &title)
 
const VariantHandle & visualization () const
 
void setVisualization (const VariantHandle &visualization)
 
virtual const Data & max () const
 
virtual const Data & min () const
 
virtual const Data & step () const
 
virtual const std::vector< EnumDescription > & descriptions () const
 
virtual unsigned int rows () const
 
virtual unsigned int cols () const
 

Detailed Description

Description of a parameter.

In addition to the information stored in the parent class parameter descriptions store information about the access mode of a given parameter. Moreover, parameter groups are supported.

Member Enumeration Documentation

§ AccessMode

enum stromx::runtime::Parameter::AccessMode

The possible access modes of a parameter.

Status None Intialized Active Executing
NO_ACCESS - - - -
NONE_READ R R R R
NONE_WRITE R/W R R R
INITIALIZED_READ - R R R
INITIALIZED_WRITE - R/W R R
ACTIVATED_WRITE - R/W R/W R/W
Enumerator
NO_ACCESS 

The parameter can never be accessed.

NONE_READ 

The parameter can be read during each status of the operator.

NONE_WRITE 

The parameter can be read during each status of the operator. It can be written during the status Operator::NONE.

INITIALIZED_READ 

The parameter can be read during the status Operator::INITIALIZED, Operator::ACTIVE and Operator::EXECUTING.

INITIALIZED_WRITE 

This parameter can be read during the status Operator::INITIALIZED, Operator::ACTIVE and Operator::EXECUTING. It can be written during the status Operator::INITIALIZED.

ACTIVATED_WRITE 

This parameter can be read during the status Operator::INITIALIZED, Operator::ACTIVE and Operator::EXECUTING. It can be written during the status Operator::INITIALIZED, Operator::ACTIVE and Operator::EXECUTING.

Constructor & Destructor Documentation

§ Parameter()

stromx::runtime::Parameter::Parameter ( const unsigned int  id,
const VariantHandle &  variant,
ParameterGroup *const  group = 0 
)

Constructs a parameter description.

Member Function Documentation

§ accessMode()

AccessMode stromx::runtime::Parameter::accessMode ( ) const
inline

Returns the access mode.

§ currentType()

virtual Type stromx::runtime::Parameter::currentType ( ) const
inlinevirtual

Input and output connectors can be configured to act as operator parameters. Such a connector is listed as an operator parameter. The current type always refers to way the connector is currently configured, i.e. possibly as a parameter.

Reimplemented from stromx::runtime::Description.

§ group()

virtual const Parameter* stromx::runtime::Parameter::group ( ) const
inlinevirtual

Returns the group the parameter belongs to. Returns 0 if the parameter does not belong to any group.

§ members()

virtual const std::vector<const Parameter*>& stromx::runtime::Parameter::members ( ) const
inlinevirtual

Returns the members of this parameter group. If the parameter is not a parameter group or it has no members the returned list is empty.

Reimplemented in stromx::runtime::ParameterGroup.

§ originalType()

virtual Type stromx::runtime::Parameter::originalType ( ) const
inlinevirtual

Input and output connectors can be configured to act as operator parameters. Such a connector is listed as an operator parameter. Its original type however remains that of a connector and signals the client that the parameter can be configured back to a connector if necessary.

Reimplemented from stromx::runtime::Description.

§ setAccessMode()

void stromx::runtime::Parameter::setAccessMode ( const AccessMode  mode)
inline

Sets the access mode.

§ setUpdateBehavior()

void stromx::runtime::Parameter::setUpdateBehavior ( const UpdateBehavior  behavior)
inline

Sets the update behavior.

§ updateBehavior()

UpdateBehavior stromx::runtime::Parameter::updateBehavior ( ) const
inline

Returns the update behavior. The update behavior describes when the value of an operator might be updated parameter by either an action from the client (i.e. Operator::setParameter()) or by the operator itself.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.12