stromx  0.7.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
stromx::runtime::MatrixDescription Class Reference

Description of a matrix description More...

#include <MatrixDescription.h>

Inheritance diagram for stromx::runtime::MatrixDescription:
stromx::runtime::Description stromx::runtime::DescriptionBase

Public Member Functions

 MatrixDescription (const unsigned int id, const VariantHandle &variant)
 
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::Description
 Description (const unsigned int id, const VariantHandle &variant)
 
unsigned int operatorThread () const
 
void setOperatorThread (const unsigned int operatorThread)
 
- Public Member Functions inherited from stromx::runtime::DescriptionBase
 DescriptionBase (const unsigned int id, const VariantHandle &variant)
 
const std::string & title () const
 
unsigned int id () const
 
const VariantHandlevariant () const
 
void setTitle (const std::string &title)
 
const VariantHandlevisualization () const
 
void setVisualization (const VariantHandle &visualization)
 
virtual const Datamax () const
 
virtual const Datamin () const
 
virtual const Datastep () const
 
virtual const std::vector
< EnumDescription > & 
descriptions () const
 

Detailed Description

Description of a matrix description

Since
0.2

Constructor & Destructor Documentation

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

Constructs a numeric parameter.

Exceptions
WrongArgumentIf variant is not a matrix variant.

Member Function Documentation

virtual unsigned int stromx::runtime::MatrixDescription::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::DescriptionBase.

virtual unsigned int stromx::runtime::MatrixDescription::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::DescriptionBase.

virtual void stromx::runtime::MatrixDescription::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.

virtual void stromx::runtime::MatrixDescription::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: