VISR  0.11.8
Versatile Interactive Scene Renderer
visr::ParameterBase Class Referenceabstract

#include <parameter_base.hpp>

Inheritance diagram for visr::ParameterBase:
visr::TypedParameterBase< BiquadParameterMatrix< CoeffType >, MatrixParameterConfig, BiquadMatrixParameterType< CoeffType >::ptype() > visr::TypedParameterBase< FilterRoutingListParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingListParameter") > visr::TypedParameterBase< FilterRoutingParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingParameter") > visr::TypedParameterBase< IndexedValueParameter< IndexType, ValueType >, EmptyParameterConfig, IndexedValueParameterType< ValueType >::ptype() > visr::TypedParameterBase< InterpolationParameter, InterpolationParameterConfig, detail::compileTimeHashFNV1("InterpolationParameter") > visr::TypedParameterBase< LateReverbParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1(sLateReverbParameterName) > visr::TypedParameterBase< ListenerPosition, EmptyParameterConfig, detail::compileTimeHashFNV1(sListenerPositionParameterName) > visr::TypedParameterBase< MatrixParameter< ElementType >, MatrixParameterConfig, MatrixParameterType< ElementType >::ptype() > visr::TypedParameterBase< ObjectVector, EmptyParameterConfig, detail::compileTimeHashFNV1("ObjectVector") > visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() > visr::TypedParameterBase< SignalRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SignalRouting") > visr::TypedParameterBase< SparseGainRoutingListParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRoutingLIst") > visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") > visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) > visr::TypedParameterBase< TimeFrequencyParameter< ElementType >, TimeFrequencyParameterConfig, TimeFrequencyParameterType< ElementType >::ptype() > visr::TypedParameterBase< VectorParameter< ElementType >, VectorParameterConfig, VectorParameterType< ElementType >::ptype() > visr::python::visr::ParameterBaseWrapper visr::TypedParameterBase< ConcreteParameterType, ParameterConfigT, typeId >

Public Member Functions

 ParameterBase ()
 
 ParameterBase (const ParameterBase &)
 
ParameterBaseoperator= (const ParameterBase &)
 
virtual ~ParameterBase ()
 
virtual ParameterType type ()=0
 
virtual std::unique_ptr< ParameterBaseclone () const =0
 
virtual void assign (ParameterBase const &rhs)=0
 

Detailed Description

Base class for parameter data types. Abstract base class.

Constructor & Destructor Documentation

◆ ParameterBase() [1/2]

visr::ParameterBase::ParameterBase ( )
default

◆ ParameterBase() [2/2]

visr::ParameterBase::ParameterBase ( const ParameterBase )
default

Copy constructor. This uses the default implementation. This function needs to be implemented explicitly because the class is exported.

◆ ~ParameterBase()

visr::ParameterBase::~ParameterBase ( )
virtualdefault

Member Function Documentation

◆ assign()

virtual void visr::ParameterBase::assign ( ParameterBase const &  rhs)
pure virtual

Virtual assingment operator. Pure virtual member function, must be implemented in derived classes.

Parameters
rhsThe object to be copied.
Exceptions
std::invalid_argumentif the type of rhs does not match the type of this object.

Implemented in visr::TypedParameterBase< ConcreteParameterType, ParameterConfigT, typeId >, visr::TypedParameterBase< MatrixParameter< ElementType >, MatrixParameterConfig, MatrixParameterType< ElementType >::ptype() >, visr::TypedParameterBase< BiquadParameterMatrix< CoeffType >, MatrixParameterConfig, BiquadMatrixParameterType< CoeffType >::ptype() >, visr::TypedParameterBase< ObjectVector, EmptyParameterConfig, detail::compileTimeHashFNV1("ObjectVector") >, visr::TypedParameterBase< ListenerPosition, EmptyParameterConfig, detail::compileTimeHashFNV1(sListenerPositionParameterName) >, visr::TypedParameterBase< VectorParameter< ElementType >, VectorParameterConfig, VectorParameterType< ElementType >::ptype() >, visr::TypedParameterBase< LateReverbParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1(sLateReverbParameterName) >, visr::TypedParameterBase< FilterRoutingListParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingListParameter") >, visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) >, visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() >, visr::TypedParameterBase< SparseGainRoutingListParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRoutingLIst") >, visr::TypedParameterBase< SignalRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SignalRouting") >, visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") >, visr::TypedParameterBase< IndexedValueParameter< IndexType, ValueType >, EmptyParameterConfig, IndexedValueParameterType< ValueType >::ptype() >, visr::TypedParameterBase< TimeFrequencyParameter< ElementType >, TimeFrequencyParameterConfig, TimeFrequencyParameterType< ElementType >::ptype() >, visr::TypedParameterBase< FilterRoutingParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingParameter") >, and visr::TypedParameterBase< InterpolationParameter, InterpolationParameterConfig, detail::compileTimeHashFNV1("InterpolationParameter") >.

◆ clone()

virtual std::unique_ptr<ParameterBase> visr::ParameterBase::clone ( ) const
pure virtual

Virtual copy constructor interface, returns a pointer to a copy of the derived object.

Implemented in visr::TypedParameterBase< ConcreteParameterType, ParameterConfigT, typeId >, visr::TypedParameterBase< MatrixParameter< ElementType >, MatrixParameterConfig, MatrixParameterType< ElementType >::ptype() >, visr::TypedParameterBase< BiquadParameterMatrix< CoeffType >, MatrixParameterConfig, BiquadMatrixParameterType< CoeffType >::ptype() >, visr::TypedParameterBase< ObjectVector, EmptyParameterConfig, detail::compileTimeHashFNV1("ObjectVector") >, visr::TypedParameterBase< ListenerPosition, EmptyParameterConfig, detail::compileTimeHashFNV1(sListenerPositionParameterName) >, visr::TypedParameterBase< VectorParameter< ElementType >, VectorParameterConfig, VectorParameterType< ElementType >::ptype() >, visr::TypedParameterBase< LateReverbParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1(sLateReverbParameterName) >, visr::TypedParameterBase< FilterRoutingListParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingListParameter") >, visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) >, visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() >, visr::TypedParameterBase< SparseGainRoutingListParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRoutingLIst") >, visr::TypedParameterBase< SignalRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SignalRouting") >, visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") >, visr::TypedParameterBase< IndexedValueParameter< IndexType, ValueType >, EmptyParameterConfig, IndexedValueParameterType< ValueType >::ptype() >, visr::TypedParameterBase< TimeFrequencyParameter< ElementType >, TimeFrequencyParameterConfig, TimeFrequencyParameterType< ElementType >::ptype() >, visr::TypedParameterBase< FilterRoutingParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingParameter") >, and visr::TypedParameterBase< InterpolationParameter, InterpolationParameterConfig, detail::compileTimeHashFNV1("InterpolationParameter") >.

◆ operator=()

ParameterBase & visr::ParameterBase::operator= ( const ParameterBase )
default

◆ type()

virtual ParameterType visr::ParameterBase::type ( )
pure virtual

Return the dynamic type of the parameter object.

Implemented in visr::TypedParameterBase< ConcreteParameterType, ParameterConfigT, typeId >, visr::TypedParameterBase< MatrixParameter< ElementType >, MatrixParameterConfig, MatrixParameterType< ElementType >::ptype() >, visr::TypedParameterBase< BiquadParameterMatrix< CoeffType >, MatrixParameterConfig, BiquadMatrixParameterType< CoeffType >::ptype() >, visr::TypedParameterBase< ObjectVector, EmptyParameterConfig, detail::compileTimeHashFNV1("ObjectVector") >, visr::TypedParameterBase< ListenerPosition, EmptyParameterConfig, detail::compileTimeHashFNV1(sListenerPositionParameterName) >, visr::TypedParameterBase< VectorParameter< ElementType >, VectorParameterConfig, VectorParameterType< ElementType >::ptype() >, visr::TypedParameterBase< LateReverbParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1(sLateReverbParameterName) >, visr::TypedParameterBase< FilterRoutingListParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingListParameter") >, visr::TypedParameterBase< StringParameter, EmptyParameterConfig, detail::compileTimeHashFNV1(sStringParameterName) >, visr::TypedParameterBase< ScalarParameter< ElementType >, EmptyParameterConfig, ScalarParameterType< ElementType >::ptype() >, visr::TypedParameterBase< SparseGainRoutingListParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRoutingLIst") >, visr::TypedParameterBase< SignalRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SignalRouting") >, visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") >, visr::TypedParameterBase< IndexedValueParameter< IndexType, ValueType >, EmptyParameterConfig, IndexedValueParameterType< ValueType >::ptype() >, visr::TypedParameterBase< TimeFrequencyParameter< ElementType >, TimeFrequencyParameterConfig, TimeFrequencyParameterType< ElementType >::ptype() >, visr::TypedParameterBase< FilterRoutingParameter, EmptyParameterConfig, detail::compileTimeHashFNV1("FilterRoutingParameter") >, and visr::TypedParameterBase< InterpolationParameter, InterpolationParameterConfig, detail::compileTimeHashFNV1("InterpolationParameter") >.


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