VISR  0.12.0
Versatile Interactive Scene Renderer
visr::rcl::SceneEncoder Class Reference

#include <scene_encoder.hpp>

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

Public Member Functions

 SceneEncoder (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 SceneEncoder (SceneEncoder const &)=delete
 
 ~SceneEncoder ()
 
void process () override
 
- 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 encode audio objects to JSON messages (typically to be sent over a network). This component has neither audio inputs or outputs.

Constructor & Destructor Documentation

visr::rcl::SceneEncoder::SceneEncoder ( 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.
visr::rcl::SceneEncoder::SceneEncoder ( SceneEncoder const &  )
delete

Disabled (deleted) copy constructor

visr::rcl::SceneEncoder::~SceneEncoder ( )

Destructor.

Member Function Documentation

void visr::rcl::SceneEncoder::process ( )
overridevirtual

Transform the incoming object vector into a JSON message.

Warning
At the moment, a message is created in each process call.
Todo:
Create a triggering/timing method to control the output rate.

Implements visr::AtomicComponent.


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