VISR  0.12.0
Versatile Interactive Scene Renderer
visr::pml::ScalarParameter< ElementType > Class Template Reference

#include <scalar_parameter.hpp>

Inheritance diagram for visr::pml::ScalarParameter< ElementType >:
visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() > visr::ParameterBase

Public Member Functions

 ScalarParameter ()
 
 ScalarParameter (ScalarParameter< ElementType > const &rhs)
 
 ScalarParameter (ParameterConfigBase const &config)
 
 ScalarParameter (EmptyParameterConfig const &config)
 
 ScalarParameter (ElementType val)
 
virtual ~ScalarParameter () override
 
ElementType & operator= (ElementType val)
 
ElementType value () const
 
- Public Member Functions inherited from visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() >
 TypedParameterBase ()=default
 
virtual ~TypedParameterBase ()=default
 
ParameterType type () final
 
std::unique_ptr< ParameterBaseclone () const final
 
void assign (ParameterBase const &rhs) override
 
- Public Member Functions inherited from visr::ParameterBase
 ParameterBase ()
 
 ParameterBase (const ParameterBase &)
 
ParameterBaseoperator= (const ParameterBase &)
 
virtual ~ParameterBase ()
 

Additional Inherited Members

- Public Types inherited from visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() >
using ParameterConfigType = EmptyParameterConfig
 
- Static Public Member Functions inherited from visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() >
static const constexpr ParameterType staticType ()
 

Detailed Description

template<typename ElementType>
class visr::pml::ScalarParameter< ElementType >

A type for passing vectors 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

◆ ScalarParameter() [1/5]

template<typename ElementType >
visr::pml::ScalarParameter< ElementType >::ScalarParameter ( )

Default constructor. In case of an elementary type, this initialises the contained scalar to an arbitrary value.

◆ ScalarParameter() [2/5]

template<typename ElementType >
visr::pml::ScalarParameter< ElementType >::ScalarParameter ( ScalarParameter< ElementType > const &  rhs)

◆ ScalarParameter() [3/5]

template<typename ElementType >
visr::pml::ScalarParameter< ElementType >::ScalarParameter ( ParameterConfigBase const &  config)
explicit

◆ ScalarParameter() [4/5]

template<typename ElementType >
visr::pml::ScalarParameter< ElementType >::ScalarParameter ( EmptyParameterConfig const &  config)
explicit

◆ ScalarParameter() [5/5]

template<typename ElementType >
visr::pml::ScalarParameter< ElementType >::ScalarParameter ( ElementType  val)
explicit

◆ ~ScalarParameter()

template<typename ElementType >
visr::pml::ScalarParameter< ElementType >::~ScalarParameter ( )
overridevirtualdefault

Member Function Documentation

◆ operator=()

template<typename ElementType >
ElementType & visr::pml::ScalarParameter< ElementType >::operator= ( ElementType  val)

◆ value()

template<typename ElementType >
ElementType visr::pml::ScalarParameter< ElementType >::value ( ) const

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