Description of an input. More...

#include <Input.h>

Inheritance diagram for stromx::runtime::Input:

Public Member Functions
	Input (const unsigned int id, const VariantHandle &variant)

virtual Type	originalType () const

virtual Type	currentType () const

Public Member Functions inherited from stromx::runtime::ConnectorDescription
virtual void	setRows (const unsigned int value)

virtual void	setCols (const unsigned int value)

unsigned int	operatorThread () const

void	setOperatorThread (const unsigned int operatorThread)

Type	defaultType () const

UpdateBehavior	defaultBehavior () const

void	setDefaultType (const Type type, const UpdateBehavior behavior=PERSISTENT)

virtual unsigned int	rows () const

virtual unsigned int	cols () 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

Additional Inherited Members
Public Types inherited from stromx::runtime::Description
enum	Type { NO_TYPE, PARAMETER, INPUT, OUTPUT }

enum	UpdateBehavior { PERSISTENT, PUSH, PULL, INTERNAL }

Protected Member Functions inherited from stromx::runtime::ConnectorDescription
	ConnectorDescription (const unsigned int id, const VariantHandle &variant, const Type defaultType)

Detailed Description

Description of an input.

Constructor & Destructor Documentation

§ Input()

stromx::runtime::Input::Input	(	const unsigned int	id,
		const VariantHandle &	variant
	)

inline

Constructs a description.

Member Function Documentation

§ currentType()

virtual Type stromx::runtime::Input::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.

§ originalType()

virtual Type stromx::runtime::Input::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.