Meta-information about an operator. More...

#include <OperatorInfo.h>

Inheritance diagram for stromx::runtime::OperatorInfo:

Public Member Functions
virtual const std::string &	type () const =0

virtual const std::string &	package () const =0

virtual const Version &	version () const =0

virtual const std::vector< const Input * > &	inputs () const =0

virtual const std::vector< const Output * > &	outputs () const =0

virtual const std::vector< const Parameter * > &	parameters () const =0

virtual const Output &	output (const unsigned int id) const =0

virtual const Input &	input (const unsigned int id) const =0

virtual const Parameter &	parameter (const unsigned int id) const =0

virtual const Description &	description (const unsigned int id) const =0

virtual const OperatorProperties &	properties () const =0

Detailed Description

Meta-information about an operator.

This class contains all the information how to use an operator without looking at its API documentaion. This information reaches its final status only after Operator::initialize() is called.

Member Function Documentation

§ description()

virtual const Description& stromx::runtime::OperatorInfo::description ( const unsigned int id ) const

pure virtual

Returns the description (i.e. input, output or parameter) id.

Exceptions

WrongId If no parameter with id exists.

Implemented in stromx::runtime::OperatorKernel.

§ input()

virtual const Input& stromx::runtime::OperatorInfo::input ( const unsigned int id ) const

pure virtual

Returns the description of the output id.

Exceptions

WrongId If no input with id exists.

Implemented in stromx::runtime::OperatorKernel.

§ inputs()

virtual const std::vector<const Input*>& stromx::runtime::OperatorInfo::inputs ( ) const

pure virtual

Returns a list of the inputs of the operator. This list can change when Operator::initialize() is called.

Implemented in stromx::runtime::OperatorKernel.

§ output()

virtual const Output& stromx::runtime::OperatorInfo::output ( const unsigned int id ) const

pure virtual

Returns the description of the input id.

Exceptions

WrongId If no output with id exists.

Implemented in stromx::runtime::OperatorKernel.

§ outputs()

virtual const std::vector<const Output*>& stromx::runtime::OperatorInfo::outputs ( ) const

pure virtual

Returns a list of the outputs of the operator. This list can change when Operator::initialize() is called. After that it is constant.

Implemented in stromx::runtime::OperatorKernel.

§ package()

virtual const std::string& stromx::runtime::OperatorInfo::package ( ) const

pure virtual

Returns the package the operator belongs to.

Implemented in stromx::runtime::OperatorKernel.

§ parameter()

virtual const Parameter& stromx::runtime::OperatorInfo::parameter ( const unsigned int id ) const

pure virtual

Returns the parameter description of the parameter id.

Exceptions

WrongId If no parameter with id exists.

Implemented in stromx::runtime::OperatorKernel.

§ parameters()

virtual const std::vector<const Parameter*>& stromx::runtime::OperatorInfo::parameters ( ) const

pure virtual

Returns a list of the parameters of the operator. This list can only change when Operator::initialize() is called. After that it is constant with exception of the properties (however, not their ID and data variant) of the single parameters.

Implemented in stromx::runtime::OperatorKernel.