stromx::runtime::MatrixParameter Class Reference

Description of a matrix parameter More...

#include <MatrixParameter.h>

Inheritance diagram for stromx::runtime::MatrixParameter:

Public Member Functions
	MatrixParameter (const unsigned int id, const VariantHandle &variant, ParameterGroup *const group=0)
virtual unsigned int	rows () const
virtual unsigned int	cols () const
virtual void	setRows (const unsigned int value)
virtual void	setCols (const unsigned int value)
Public Member Functions inherited from stromx::runtime::Parameter
	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

Additional Inherited Members
Public Types inherited from stromx::runtime::Parameter
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 }

Detailed Description

Description of a matrix parameter

Since

0.2

Constructor & Destructor Documentation

MatrixParameter()

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

Constructs a numeric parameter.

Exceptions

WrongArgument

If variant is not a matrix variant.

Member Function Documentation

cols()

virtual unsigned int stromx::runtime::MatrixParameter::cols ( ) const

inlinevirtual

Returns the required number of columns of a matrix parameters. Returns 0 if any number of columns is possible.

Reimplemented from stromx::runtime::Description.

rows()

virtual unsigned int stromx::runtime::MatrixParameter::rows ( ) const

inlinevirtual

Returns the required number of rows of a matrix parameters. Returns 0 if any number of rows is possible.

Reimplemented from stromx::runtime::Description.

setCols()

virtual void stromx::runtime::MatrixParameter::setCols ( const unsigned int  value )

inlinevirtual

Sets the required number of matrix rows of this parameter. Passing 0 for value allows any number of rows.

setRows()

virtual void stromx::runtime::MatrixParameter::setRows ( const unsigned int  value )

inlinevirtual

Sets the required number of matrix rows of this parameter. Passing 0 for value allows any number of rows.

---

The documentation for this class was generated from the following files:

• stromx/runtime/MatrixParameter.h
• stromx/runtime/MatrixParameter.cpp