VISR  0.12.0
Versatile Interactive Scene Renderer
visr::pml::VectorParameterConfig Class Reference

#include <vector_parameter_config.hpp>

Inheritance diagram for visr::pml::VectorParameterConfig:
visr::ParameterConfigBase

Public Member Functions

 VectorParameterConfig (std::size_t numberOfElements)
 
virtual ~VectorParameterConfig ()
 
std::unique_ptr< ParameterConfigBaseclone () const override
 
bool compare (ParameterConfigBase const &rhs) const override
 
bool compare (VectorParameterConfig const &rhs) const
 
std::size_t numberOfElements () 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 encapsulating the configuration of a vector parameter.

Constructor & Destructor Documentation

◆ VectorParameterConfig()

visr::pml::VectorParameterConfig::VectorParameterConfig ( std::size_t  numberOfElements)
explicit

◆ ~VectorParameterConfig()

visr::pml::VectorParameterConfig::~VectorParameterConfig ( )
virtual

Member Function Documentation

◆ clone()

std::unique_ptr< ParameterConfigBase > visr::pml::VectorParameterConfig::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.

◆ compare() [1/2]

bool visr::pml::VectorParameterConfig::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.

◆ compare() [2/2]

bool visr::pml::VectorParameterConfig::compare ( VectorParameterConfig const &  rhs) const

◆ numberOfElements()

std::size_t visr::pml::VectorParameterConfig::numberOfElements ( ) const
inline

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