All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SurgSim::Framework::Component Class Referenceabstract

Component is the main interface class to pass information to the system managers each will decide whether to handle a component of a given type or not. More...

#include <SurgSim/Framework/Component.h>

Inheritance diagram for SurgSim::Framework::Component:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Framework::Component:
Collaboration graph
[legend]

Public Types

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
 

Public Member Functions

 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...
 
virtual bool doInitialize ()=0
 Interface to be implemented by derived classes. More...
 
virtual bool doWakeUp ()=0
 Interface to be implemented by derived classes. 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
 

Static Public Member Functions

static FactoryTypegetFactory ()
 

Protected Member Functions

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...
 

Private Attributes

std::string m_name
 Name of this component. More...
 
boost::uuids::uuid m_uuid
 Id of this component. More...
 
std::weak_ptr< Runtimem_runtime
 Runtime which contains this component. More...
 
std::weak_ptr< Scenem_scene
 Scene which contains this component. More...
 
std::weak_ptr< SceneElementm_sceneElement
 SceneElement which contains this component. More...
 
bool m_didInit
 Indicates if doInitialize() has been called. More...
 
bool m_didWakeUp
 Indicates if doWakeup() has been called. More...
 
bool m_isInitialized
 Indicates if this component is initialized. More...
 
bool m_isAwake
 Indicates if this component is awake. More...
 
bool m_isLocalActive
 Indicates if this component is active. More...
 

Detailed Description

Component is the main interface class to pass information to the system managers each will decide whether to handle a component of a given type or not.

Components will get initialized by having doInit(), and doWakeUp() called in succession, all components together will have doInit() called before any component will recieve doWakeUp()

Member Typedef Documentation

Constructor & Destructor Documentation

SurgSim::Framework::Component::Component ( const std::string &  name)
explicit

Constructor.

Parameters
nameName of the component
SurgSim::Framework::Component::~Component ( )
virtual

Destructor.

Member Function Documentation

virtual bool SurgSim::Framework::Component::doInitialize ( )
pure virtual
virtual bool SurgSim::Framework::Component::doWakeUp ( )
pure virtual
std::string SurgSim::Framework::Component::getClassName ( ) const
virtual

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.

Note
Use the SURGSIM_CLASSNAME macro in derived classes.
Returns
The fully namespace qualified name of this class.
Component::FactoryType & SurgSim::Framework::Component::getFactory ( )
static
Returns
The static class factory that is being used in the conversion.
std::string SurgSim::Framework::Component::getName ( ) const

Gets component name.

Returns
Name of this component.
std::shared_ptr< PoseComponent > SurgSim::Framework::Component::getPoseComponent ( )
protectedvirtual

Get the PoseComponent for this component.

Returns
The PoseComponent

Reimplemented in SurgSim::Framework::PoseComponent.

std::shared_ptr< const PoseComponent > SurgSim::Framework::Component::getPoseComponent ( ) const
protectedvirtual

Get the PoseComponent for this component, constant access.

Returns
The PoseComponent

Reimplemented in SurgSim::Framework::PoseComponent.

std::shared_ptr< Runtime > SurgSim::Framework::Component::getRuntime ( ) const

Get the runtime which contains this component.

Returns
The runtime which contains this component.
std::shared_ptr< Scene > SurgSim::Framework::Component::getScene ( )

Gets the scene.

Returns
The scene for this component
std::shared_ptr< SceneElement > SurgSim::Framework::Component::getSceneElement ( )

Gets the scene element.

Returns
The scene element for this component.
std::shared_ptr< const SceneElement > SurgSim::Framework::Component::getSceneElement ( ) const

Gets the scene element, constant version.

Returns
The scene element for this component.
std::shared_ptr< Component > SurgSim::Framework::Component::getSharedPtr ( )

Gets a shared pointer to this component.

Returns
The shared pointer.
boost::uuids::uuid SurgSim::Framework::Component::getUuid ( ) const

Gets the id of the component.

bool SurgSim::Framework::Component::initialize ( const std::weak_ptr< Runtime > &  runtime)

Initialize this component, this needs to be called before wakeUp() can be called.

This will be done automatically by the Scene hierarchy, either in SceneElement::addComponent(), if SceneElement has already been added to the Scene, or through Scene::addSceneElement() on all Components on the SceneElement.

Parameters
runtimeThe runtime which contains this component.
Returns
True if this component is initialized successfully; otherwise, false.
bool SurgSim::Framework::Component::isActive ( ) const
Returns
True if this component is active and its SceneElement (if any) is also active; Otherwise, false.
bool SurgSim::Framework::Component::isAwake ( ) const
Returns
True if this component is awake; otherwise, false.
bool SurgSim::Framework::Component::isInitialized ( ) const
Returns
True if this component is initialized; otherwise, false.
bool SurgSim::Framework::Component::isLocalActive ( ) const
Returns
True if this component is active Otherwise, false.
void SurgSim::Framework::Component::setLocalActive ( bool  val)
virtual

Set the component's active state.

Parameters
valIf true component is active, inactive if false.

Reimplemented in SurgSim::Graphics::Representation.

void SurgSim::Framework::Component::setName ( const std::string &  name)

Sets the name of component.

Parameters
nameThe name of this component.
void SurgSim::Framework::Component::setScene ( std::weak_ptr< Scene scene)

Sets the scene.

Parameters
sceneThe scene for this component
void SurgSim::Framework::Component::setSceneElement ( std::weak_ptr< SceneElement sceneElement)

Sets the scene element.

Parameters
sceneElementThe scene element for this component.
bool SurgSim::Framework::Component::wakeUp ( )

Wakeup this component, this will be called when the component is inserted into the ComponentManager that is responsible for handling this component.

Returns
True if this component is woken up successfully; otherwise, false.

Member Data Documentation

bool SurgSim::Framework::Component::m_didInit
private

Indicates if doInitialize() has been called.

bool SurgSim::Framework::Component::m_didWakeUp
private

Indicates if doWakeup() has been called.

bool SurgSim::Framework::Component::m_isAwake
private

Indicates if this component is awake.

bool SurgSim::Framework::Component::m_isInitialized
private

Indicates if this component is initialized.

bool SurgSim::Framework::Component::m_isLocalActive
private

Indicates if this component is active.

std::string SurgSim::Framework::Component::m_name
private

Name of this component.

std::weak_ptr<Runtime> SurgSim::Framework::Component::m_runtime
private

Runtime which contains this component.

std::weak_ptr<Scene> SurgSim::Framework::Component::m_scene
private

Scene which contains this component.

std::weak_ptr<SceneElement> SurgSim::Framework::Component::m_sceneElement
private

SceneElement which contains this component.

boost::uuids::uuid SurgSim::Framework::Component::m_uuid
private

Id of this component.


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