VISR  0.11.7
Versatile Interactive Scene Renderer
visr::impl::ParameterPortBaseImplementation Class Reference

#include <parameter_port_base_implementation.hpp>

Inheritance diagram for visr::impl::ParameterPortBaseImplementation:
visr::impl::PortBaseImplementation

Public Member Functions

 ParameterPortBaseImplementation (char const *name, ParameterPortBase &containingPort, ComponentImplementation *parent, visr::PortBase::Direction direction, ParameterType const &parameterType, CommunicationProtocolType const &protocolType, ParameterConfigBase const &parameterConfig)
 
 ParameterPortBaseImplementation (char const *name, ParameterPortBase &containingPort, ComponentImplementation *parent, visr::PortBase::Direction direction, ParameterType const &parameterType, CommunicationProtocolType const &protocolType)
 
virtual ~ParameterPortBaseImplementation ()
 
void setParameterConfig (ParameterConfigBase const &parameterConfig)
 
ParameterPortBasecontainingPort ()
 
ParameterPortBase const & containingPort () const
 
ParameterType parameterType () const
 
CommunicationProtocolType protocolType () const
 
bool hasParameterConfig () const noexcept
 
ParameterConfigBase const & parameterConfig () const
 
- Public Member Functions inherited from visr::impl::PortBaseImplementation
 PortBaseImplementation (char const *name, ComponentImplementation *container, visr::PortBase::Direction direction)
 
 PortBaseImplementation ()=delete
 
 PortBaseImplementation (PortBaseImplementation const &)=delete
 
 PortBaseImplementation (PortBaseImplementation &&)=delete
 
PortBaseImplementationoperator= (PortBaseImplementation const &)=delete
 
PortBaseImplementationoperator= (PortBaseImplementation &&)=delete
 
 ~PortBaseImplementation ()
 
char const * name () const
 
bool hasParent () const noexcept
 
ComponentImplementation const & parent () const
 
ComponentImplementationparent ()
 
void setParent (ComponentImplementation *newParent) noexcept
 
void removeParent () noexcept
 
visr::PortBase::Direction direction () const
 

Protected Attributes

ParameterPortBasemContainingPort
 
visr::ParameterType const mParameterType
 
visr::CommunicationProtocolType const mProtocolType
 
std::unique_ptr< visr::ParameterConfigBasemParameterConfig
 

Constructor & Destructor Documentation

◆ ParameterPortBaseImplementation() [1/2]

visr::impl::ParameterPortBaseImplementation::ParameterPortBaseImplementation ( char const *  name,
ParameterPortBase containingPort,
ComponentImplementation parent,
visr::PortBase::Direction  direction,
ParameterType const &  parameterType,
CommunicationProtocolType const &  protocolType,
ParameterConfigBase const &  parameterConfig 
)
explicit

◆ ParameterPortBaseImplementation() [2/2]

visr::impl::ParameterPortBaseImplementation::ParameterPortBaseImplementation ( char const *  name,
ParameterPortBase containingPort,
ComponentImplementation parent,
visr::PortBase::Direction  direction,
ParameterType const &  parameterType,
CommunicationProtocolType const &  protocolType 
)
explicit

◆ ~ParameterPortBaseImplementation()

visr::impl::ParameterPortBaseImplementation::~ParameterPortBaseImplementation ( )
virtual

@ TODO: Do we intend to use parameter ports in a virtual way? Obviously yes.

Member Function Documentation

◆ containingPort() [1/2]

ParameterPortBase & visr::impl::ParameterPortBaseImplementation::containingPort ( )

◆ containingPort() [2/2]

ParameterPortBase const & visr::impl::ParameterPortBaseImplementation::containingPort ( ) const

◆ hasParameterConfig()

bool visr::impl::ParameterPortBaseImplementation::hasParameterConfig ( ) const
noexcept

Query whether a parameter configuration exists (set either in the constructor or using setParameterConfig() )

◆ parameterConfig()

ParameterConfigBase const & visr::impl::ParameterPortBaseImplementation::parameterConfig ( ) const

Return the paramaeter configuration object for this port.

Exceptions
std::logic_errorIf no parameter configuration has been set.

◆ parameterType()

ParameterType visr::impl::ParameterPortBaseImplementation::parameterType ( ) const

◆ protocolType()

CommunicationProtocolType visr::impl::ParameterPortBaseImplementation::protocolType ( ) const

◆ setParameterConfig()

void visr::impl::ParameterPortBaseImplementation::setParameterConfig ( ParameterConfigBase const &  parameterConfig)

Set a new parameter type configuration for this port. An already existing configuration will be replaced.

Member Data Documentation

◆ mContainingPort

ParameterPortBase& visr::impl::ParameterPortBaseImplementation::mContainingPort
protected

◆ mParameterConfig

std::unique_ptr<visr::ParameterConfigBase> visr::impl::ParameterPortBaseImplementation::mParameterConfig
protected

◆ mParameterType

visr::ParameterType const visr::impl::ParameterPortBaseImplementation::mParameterType
protected

◆ mProtocolType

visr::CommunicationProtocolType const visr::impl::ParameterPortBaseImplementation::mProtocolType
protected

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