VISR  0.11.6
Versatile Interactive Scene Renderer
visr::rcl::ScalarOscDecoder Class Reference

#include <scalar_osc_decoder.hpp>

Inheritance diagram for visr::rcl::ScalarOscDecoder:
visr::AtomicComponent visr::Component

Public Types

enum  DataType {
  DataType::Boolean, DataType::Integer, DataType::UnsignedInteger, DataType::Float,
  DataType::Double
}
 

Public Member Functions

 ScalarOscDecoder (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 ScalarOscDecoder (ScalarOscDecoder const &)=delete
 
 ~ScalarOscDecoder ()
 
void setup (char const *dataType)
 
void process ()
 
- Public Member Functions inherited from visr::AtomicComponent
 AtomicComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 AtomicComponent (AtomicComponent const &)=delete
 
 AtomicComponent (AtomicComponent &&)=delete
 
virtual ~AtomicComponent () override
 
- Public Member Functions inherited from visr::Component
 Component (SignalFlowContext const &context, char const *componentName, CompositeComponent *parent)
 
 Component (SignalFlowContext const &context, std::string const &componentName, CompositeComponent *parent)
 
 Component (Component const &)=delete
 
 Component (Component &&)=delete
 
Componentoperator= (Component const &)=delete
 
Componentoperator= (Component &&)=delete
 
virtual ~Component ()
 
std::string const & name () const
 
std::string fullName () const
 
void status (StatusMessage::Kind status, char const *message)
 
template<typename ... MessageArgs>
void status (StatusMessage::Kind status, MessageArgs ... args)
 
bool isComposite () const
 
AudioPortBaseaudioPort (char const *portName)
 
AudioPortBase const & audioPort (char const *portName) const
 
AudioPortBaseaudioPort (std::string const &portName)
 
AudioPortBase const & audioPort (std::string const &portName) const
 
ParameterPortBaseparameterPort (char const *portName)
 
ParameterPortBase const & parameterPort (char const *portName) const
 
ParameterPortBaseparameterPort (std::string const &portName)
 
ParameterPortBase const & parameterPort (std::string const &portName) const
 
SamplingFrequencyType samplingFrequency () const
 
std::size_t period () const
 
bool isTopLevel () const
 
impl::ComponentImplementationimplementation ()
 
impl::ComponentImplementation const & implementation () const
 

Additional Inherited Members

- Static Public Member Functions inherited from visr::Component
static const std::string & nameSeparator ()
 
- Protected Member Functions inherited from visr::Component
 Component (impl::ComponentImplementation *impl)
 

Detailed Description

Component to decode OSC messages containing a single integer and to fill a signal routing parameter list accordingly.

Member Enumeration Documentation

◆ DataType

Enumerator
Boolean 
Integer 
UnsignedInteger 
Float 
Double 

Constructor & Destructor Documentation

◆ ScalarOscDecoder() [1/2]

visr::rcl::ScalarOscDecoder::ScalarOscDecoder ( SignalFlowContext const &  context,
char const *  name,
CompositeComponent parent = nullptr 
)
explicit

Constructor.

Parameters
contextConfiguration object containing basic execution parameters.
nameThe name of the component. Must be unique within the containing composite component (if there is one).
parentPointer to a containing component if there is one. Specify nullptr in case of a top-level component.

◆ ScalarOscDecoder() [2/2]

visr::rcl::ScalarOscDecoder::ScalarOscDecoder ( ScalarOscDecoder const &  )
delete

Disabled (deleted) copy constructor

◆ ~ScalarOscDecoder()

visr::rcl::ScalarOscDecoder::~ScalarOscDecoder ( )

Destructor.

Member Function Documentation

◆ process()

void visr::rcl::ScalarOscDecoder::process ( )
virtual

The process function.

Implements visr::AtomicComponent.

◆ setup()

void visr::rcl::ScalarOscDecoder::setup ( char const *  dataType)

Method to initialise the component.


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