VISR  0.11.8
Versatile Interactive Scene Renderer
visr::pml::MatrixParameterConfig Class Reference

#include <matrix_parameter_config.hpp>

Inheritance diagram for visr::pml::MatrixParameterConfig:
visr::ParameterConfigBase

Public Member Functions

 MatrixParameterConfig (std::size_t numberOfRows, std::size_t numberOfColumns)
 
virtual ~MatrixParameterConfig ()
 
std::unique_ptr< ParameterConfigBaseclone () const override
 
bool compare (ParameterConfigBase const &rhs) const override
 
bool compare (MatrixParameterConfig const &rhs) const
 
std::size_t numberOfRows () const
 
std::size_t numberOfColumns () const
 
- Public Member Functions inherited from visr::ParameterConfigBase
virtual ~ParameterConfigBase ()
 

Additional Inherited Members

- Protected Member Functions inherited from visr::ParameterConfigBase
 ParameterConfigBase ()
 
 ParameterConfigBase (ParameterConfigBase const &)
 

Detailed Description

A type for passing matrixes between processing components. The template class is explicitly instantiated for the element types float and double.

Template Parameters
ElementTypeThe data type of the elements of the matrix.

Constructor & Destructor Documentation

visr::pml::MatrixParameterConfig::MatrixParameterConfig ( std::size_t  numberOfRows,
std::size_t  numberOfColumns 
)
visr::pml::MatrixParameterConfig::~MatrixParameterConfig ( )
virtualdefault

Member Function Documentation

std::unique_ptr< ParameterConfigBase > visr::pml::MatrixParameterConfig::clone ( ) const
overridevirtual

Clone (virtual copy construction) function. Pure virtual function, must be defined in derived types.

Returns
A shared pointer to an object of the derived type.

Implements visr::ParameterConfigBase.

bool visr::pml::MatrixParameterConfig::compare ( ParameterConfigBase const &  rhs) const
overridevirtual

Comparison function between parameter configurations. Must only be called between objects of equal dynamic type. Pure virtual function interface, must be implemented by derived parameter config types.

Parameters
rhsThe parameter configuration object to compare with.
Returns
True if the parameter objects are compatible, false otherwise
Exceptions
std::invalid_argumentit the this object and rhs have nonmatching dynamic types.

Implements visr::ParameterConfigBase.

bool visr::pml::MatrixParameterConfig::compare ( MatrixParameterConfig const &  rhs) const
std::size_t visr::pml::MatrixParameterConfig::numberOfColumns ( ) const
inline
std::size_t visr::pml::MatrixParameterConfig::numberOfRows ( ) const
inline

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