All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
SurgSim::Input::OutputComponent Class Reference

OutputComponent is a Component that has an OutputProducer, a concrete instance of OutputProducerInterface, so that output devices can receive data through the normal component interface to SceneElements. More...

#include <SurgSim/Input/OutputComponent.h>

Inheritance diagram for SurgSim::Input::OutputComponent:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Input::OutputComponent:
Collaboration graph
[legend]

Public Member Functions

 OutputComponent (const std::string &name)
 Constructor. More...
 
virtual ~OutputComponent ()
 Destructor. More...
 
 SURGSIM_CLASSNAME (SurgSim::Input::OutputComponent)
 
void setDeviceName (const std::string &deviceName)
 Set name of the device of output component. More...
 
bool isDeviceConnected ()
 Is a device connected. More...
 
void connectDevice (std::shared_ptr< SurgSim::Input::DeviceInterface > device)
 Connect to a device This call will be made by the InputManager, and should generally not be called directly. More...
 
void disconnectDevice (std::shared_ptr< SurgSim::Input::DeviceInterface > device)
 Disconnect from a device This call will be made by the InputManager, and should generally not be called directly. More...
 
void setData (const SurgSim::DataStructures::DataGroup &dataGroup)
 Sets the output data. More...
 
virtual bool doInitialize ()
 Overridden from Component, do nothing. More...
 
virtual bool doWakeUp ()
 Overridden from Component, do nothing. More...
 
std::string getDeviceName () const
 Gets device name. More...
 
- Public Member Functions inherited from SurgSim::Framework::Component
 Component (const std::string &name)
 Constructor. More...
 
virtual ~Component ()
 Destructor. More...
 
std::string getName () const
 Gets component name. More...
 
void setName (const std::string &name)
 Sets the name of component. More...
 
boost::uuids::uuid getUuid () const
 Gets the id of the component. More...
 
bool isInitialized () const
 
bool initialize (const std::weak_ptr< Runtime > &runtime)
 Initialize this component, this needs to be called before wakeUp() can be called. More...
 
bool isAwake () const
 
bool wakeUp ()
 Wakeup this component, this will be called when the component is inserted into the ComponentManager that is responsible for handling this component. More...
 
void setScene (std::weak_ptr< Scene > scene)
 Sets the scene. More...
 
std::shared_ptr< ScenegetScene ()
 Gets the scene. More...
 
void setSceneElement (std::weak_ptr< SceneElement > sceneElement)
 Sets the scene element. More...
 
std::shared_ptr< SceneElementgetSceneElement ()
 Gets the scene element. More...
 
std::shared_ptr< const
SceneElement
getSceneElement () const
 Gets the scene element, constant version. More...
 
std::shared_ptr< RuntimegetRuntime () const
 Get the runtime which contains this component. More...
 
virtual std::string getClassName () const
 The class name for this class, this being the base class it should return SurgSim::Framework::Component but this would make missing implemenentations of this hard to catch, therefore this calls SURGSIM_FAILURE. More...
 
std::shared_ptr< ComponentgetSharedPtr ()
 Gets a shared pointer to this component. More...
 
bool isActive () const
 
virtual void setLocalActive (bool val)
 Set the component's active state. More...
 
bool isLocalActive () const
 
- Public Member Functions inherited from SurgSim::Framework::Accessible
 Accessible ()
 Default Constructor. More...
 
 ~Accessible ()
 Destructor. More...
 
template<class T >
getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
 
boost::any getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found. More...
 
template<class T >
bool getValue (const std::string &name, T *value) const
 Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
 
void setValue (const std::string &name, const boost::any &value)
 Sets a value of a property that has setter. More...
 
bool isReadable (const std::string &name) const
 Check whether a property is readable. More...
 
bool isWriteable (const std::string &name) const
 Check whether a property is writable. More...
 
void setGetter (const std::string &name, GetterType func)
 Sets a getter for a given property. More...
 
void setSetter (const std::string &name, SetterType func)
 Sets a setter for a given property. More...
 
void setAccessors (const std::string &name, GetterType getter, SetterType setter)
 Sets the accessors getter and setter in one function. More...
 
void removeAccessors (const std::string &name)
 Removes all the accessors (getter and setter) for a given property. More...
 
void forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
 Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
 
void setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
 Sets the functions used to convert data from and to a YAML::Node. More...
 
YAML::Node encode () const
 Encode this Accessible to a YAML::Node. More...
 
void decode (const YAML::Node &node)
 Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
 
template<>
boost::any getValue (const std::string &name) const
 

Private Attributes

std::string m_deviceName
 Name of the device to which this output component connects. More...
 
bool m_deviceConnected
 Indicates if this output component is connected to a device. More...
 
std::shared_ptr< OutputProducerm_output
 Output producer which sends data to hardware device. More...
 

Additional Inherited Members

- Public Types inherited from SurgSim::Framework::Component
typedef
SurgSim::Framework::ObjectFactory1
< SurgSim::Framework::Component,
std::string > 
FactoryType
 
- Public Types inherited from SurgSim::Framework::Accessible
typedef std::function
< boost::any(void)> 
GetterType
 
typedef std::function< void(boost::any)> SetterType
 
typedef std::function
< YAML::Node(void)> 
EncoderType
 
typedef std::function< void(const
YAML::Node *)> 
DecoderType
 
- Static Public Member Functions inherited from SurgSim::Framework::Component
static FactoryTypegetFactory ()
 
- Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr
< PoseComponent
getPoseComponent ()
 Get the PoseComponent for this component. More...
 
virtual std::shared_ptr< const
PoseComponent
getPoseComponent () const
 Get the PoseComponent for this component, constant access. More...
 

Detailed Description

OutputComponent is a Component that has an OutputProducer, a concrete instance of OutputProducerInterface, so that output devices can receive data through the normal component interface to SceneElements.

Constructor & Destructor Documentation

SurgSim::Input::OutputComponent::OutputComponent ( const std::string &  name)
explicit

Constructor.

Parameters
nameName of this output component
SurgSim::Input::OutputComponent::~OutputComponent ( )
virtual

Destructor.

Member Function Documentation

void SurgSim::Input::OutputComponent::connectDevice ( std::shared_ptr< SurgSim::Input::DeviceInterface device)

Connect to a device This call will be made by the InputManager, and should generally not be called directly.

Parameters
deviceThe device to connect to.
void SurgSim::Input::OutputComponent::disconnectDevice ( std::shared_ptr< SurgSim::Input::DeviceInterface device)

Disconnect from a device This call will be made by the InputManager, and should generally not be called directly.

Parameters
deviceThe device to disconnect from.
bool SurgSim::Input::OutputComponent::doInitialize ( )
virtual

Overridden from Component, do nothing.

Implements SurgSim::Framework::Component.

bool SurgSim::Input::OutputComponent::doWakeUp ( )
virtual

Overridden from Component, do nothing.

Implements SurgSim::Framework::Component.

std::string SurgSim::Input::OutputComponent::getDeviceName ( ) const

Gets device name.

Returns
The device name.
bool SurgSim::Input::OutputComponent::isDeviceConnected ( )

Is a device connected.

Returns
true if a device has been connected.
void SurgSim::Input::OutputComponent::setData ( const SurgSim::DataStructures::DataGroup dataGroup)

Sets the output data.

Parameters
dataGroupThe data to output.
void SurgSim::Input::OutputComponent::setDeviceName ( const std::string &  deviceName)

Set name of the device of output component.

param deviceName The name of the device that will receive the output data.

SurgSim::Input::OutputComponent::SURGSIM_CLASSNAME ( SurgSim::Input::OutputComponent  )

Member Data Documentation

bool SurgSim::Input::OutputComponent::m_deviceConnected
private

Indicates if this output component is connected to a device.

std::string SurgSim::Input::OutputComponent::m_deviceName
private

Name of the device to which this output component connects.

std::shared_ptr<OutputProducer> SurgSim::Input::OutputComponent::m_output
private

Output producer which sends data to hardware device.


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