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

Behavior to copy a pose from an input component to a SceneElement By adding this behavior to a SceneElement, that SceneElement will be moved in correspondance to the input. More...

#include <SurgSim/Blocks/DriveElementFromInputBehavior.h>

Inheritance diagram for SurgSim::Blocks::DriveElementFromInputBehavior:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Blocks::DriveElementFromInputBehavior:
Collaboration graph
[legend]

Public Member Functions

 DriveElementFromInputBehavior (const std::string &name)
 Constructor. More...
 
 SURGSIM_CLASSNAME (SurgSim::Blocks::DriveElementFromInputBehavior)
 
void setSource (std::shared_ptr< SurgSim::Framework::Component > source)
 Set the InputComponent that provides the pose. More...
 
std::shared_ptr
< SurgSim::Framework::Component
getSource ()
 Get the InputComponent which is being used by this behavior. More...
 
void setPoseName (const std::string &poseName)
 Set name of the pose. More...
 
std::string getPoseName ()
 Get name of the pose. More...
 
virtual void update (double dt)
 Update the behavior. More...
 
- Public Member Functions inherited from SurgSim::Framework::Behavior
 Behavior (const std::string &name)
 
virtual ~Behavior ()
 
virtual int getTargetManagerType () const
 Specifies which manger will handle this behavior. 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
 

Protected Member Functions

virtual bool doInitialize ()
 Initialize the behavior. More...
 
virtual bool doWakeUp ()
 Wakeup the behavior, which copies the initial pose. More...
 
- 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...
 

Private Attributes

std::shared_ptr
< SurgSim::Input::InputComponent
m_source
 InputComponent to get the pose. More...
 
std::string m_poseName
 

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 ()
 

Detailed Description

Behavior to copy a pose from an input component to a SceneElement By adding this behavior to a SceneElement, that SceneElement will be moved in correspondance to the input.

Constructor & Destructor Documentation

SurgSim::Blocks::DriveElementFromInputBehavior::DriveElementFromInputBehavior ( const std::string &  name)
explicit

Constructor.

Parameters
nameName of the behavior

Member Function Documentation

bool SurgSim::Blocks::DriveElementFromInputBehavior::doInitialize ( )
protectedvirtual

Initialize the behavior.

Implements SurgSim::Framework::Component.

bool SurgSim::Blocks::DriveElementFromInputBehavior::doWakeUp ( )
protectedvirtual

Wakeup the behavior, which copies the initial pose.

Implements SurgSim::Framework::Component.

std::string SurgSim::Blocks::DriveElementFromInputBehavior::getPoseName ( )

Get name of the pose.

Returns
The name of the pose.
std::shared_ptr< SurgSim::Framework::Component > SurgSim::Blocks::DriveElementFromInputBehavior::getSource ( )

Get the InputComponent which is being used by this behavior.

Returns
A SurgSim::Component::InputComponent
void SurgSim::Blocks::DriveElementFromInputBehavior::setPoseName ( const std::string &  poseName)

Set name of the pose.

Parameters
poseNameThe name of the pose.
void SurgSim::Blocks::DriveElementFromInputBehavior::setSource ( std::shared_ptr< SurgSim::Framework::Component source)

Set the InputComponent that provides the pose.

Parameters
sourceA SurgSim::Input::InputComponent
SurgSim::Blocks::DriveElementFromInputBehavior::SURGSIM_CLASSNAME ( SurgSim::Blocks::DriveElementFromInputBehavior  )
void SurgSim::Blocks::DriveElementFromInputBehavior::update ( double  dt)
virtual

Update the behavior.

Parameters
dtThe length of time (seconds) between update calls.

Implements SurgSim::Framework::Behavior.

Member Data Documentation

std::string SurgSim::Blocks::DriveElementFromInputBehavior::m_poseName
private
std::shared_ptr<SurgSim::Input::InputComponent> SurgSim::Blocks::DriveElementFromInputBehavior::m_source
private

InputComponent to get the pose.


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