VISR  0.11.1
Versatile Interactive Scene Renderer
visr::ParameterInputBase Class Referenceabstract

#include <parameter_input.hpp>

Inheritance diagram for visr::ParameterInputBase:
visr::ParameterPortBase visr::ParameterInput< visr::pml::DoubleBufferingProtocol, visr::pml::ListenerPosition > visr::ParameterInput< visr::pml::DoubleBufferingProtocol, visr::pml::ObjectVector > visr::ParameterInput< visr::pml::DoubleBufferingProtocol, visr::pml::VectorParameter< SampleType > > visr::ParameterInput< visr::pml::MessageQueueProtocol, visr::pml::StringParameter > visr::ParameterInput< visr::pml::MessageQueueProtocol, visr::reverbobject::LateReverbParameter > visr::ParameterInput< visr::pml::SharedDataProtocol, visr::pml::MatrixParameter< SampleType > > visr::ParameterInput< visr::pml::SharedDataProtocol, visr::pml::ObjectVector > visr::ParameterInput< visr::pml::SharedDataProtocol, visr::pml::TimeFrequencyParameter< SampleType > > visr::ParameterInput< ProtocolT, ParameterT > visr::PolymorphicParameterInput

Public Member Functions

 ParameterInputBase (char const *name, Component &parent, ParameterType const &parameterType, CommunicationProtocolType const &protocolType, ParameterConfigBase const &paramConfig)
 
 ParameterInputBase (char const *name, Component &parent, ParameterType const &parameterType, CommunicationProtocolType const &protocolType)
 
virtual ~ParameterInputBase () override
 
virtual CommunicationProtocolBase::InputprotocolInput ()=0
 
void setParameterConfig (ParameterConfigBase const &parameterConfig)
 
- Public Member Functions inherited from visr::ParameterPortBase
 ParameterPortBase (char const *name, Component &parent, PortBase::Direction direction, ParameterType const &parameterType, CommunicationProtocolType const &protocolType, ParameterConfigBase const &parameterConfig)
 
 ParameterPortBase (char const *name, Component &parent, PortBase::Direction direction, ParameterType const &parameterType, CommunicationProtocolType const &protocolType)
 
 ParameterPortBase (ParameterPortBase const &)=delete
 
 ParameterPortBase (ParameterPortBase &&)=delete
 
ParameterPortBaseoperator= (ParameterPortBase const &)=delete
 
ParameterPortBaseoperator= (ParameterPortBase &&)=delete
 
virtual ~ParameterPortBase ()
 
void setParameterConfig (ParameterConfigBase const &parameterConfig)
 
ParameterType parameterType () const
 
CommunicationProtocolType protocolType () const
 
ParameterConfigBase const & parameterConfig () const
 
impl::ParameterPortBaseImplementationimplementation ()
 
impl::ParameterPortBaseImplementation const & implementation () const
 

Additional Inherited Members

- Public Types inherited from visr::ParameterPortBase
using Direction = PortBase::Direction
 
- Protected Member Functions inherited from visr::ParameterPortBase
virtual void setProtocol (CommunicationProtocolBase *protocol)=0
 

Constructor & Destructor Documentation

◆ ParameterInputBase() [1/2]

visr::ParameterInputBase::ParameterInputBase ( char const *  name,
Component parent,
ParameterType const &  parameterType,
CommunicationProtocolType const &  protocolType,
ParameterConfigBase const &  paramConfig 
)
explicit

◆ ParameterInputBase() [2/2]

visr::ParameterInputBase::ParameterInputBase ( char const *  name,
Component parent,
ParameterType const &  parameterType,
CommunicationProtocolType const &  protocolType 
)
explicit

◆ ~ParameterInputBase()

visr::ParameterInputBase::~ParameterInputBase ( )
overridevirtualdefault

Member Function Documentation

◆ protocolInput()

◆ setParameterConfig()

void visr::ParameterPortBase::setParameterConfig

Set a new parameter configuration. If a configuration is already set, it is overwritten. Must be called only during the initialisation phase

Parameters
parameterConfigThe new parameter configuration.
Exceptions
std::runtime_errorWhen called after the signal flow is initialised.

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