All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
SurgSim::Framework::Behavior Class Referenceabstract

Behaviors perform actions. More...

#include <SurgSim/Framework/Behavior.h>

Inheritance diagram for SurgSim::Framework::Behavior:
Inheritance graph
Collaboration diagram for SurgSim::Framework::Behavior:
Collaboration graph

Public Member Functions

 Behavior (const std::string &name)
virtual ~Behavior ()
virtual void update (double dt)=0
 Update the behavior. More...
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
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...
boost::any getValue (const std::string &name) const

Additional Inherited Members

- Public Types inherited from SurgSim::Framework::Component
< SurgSim::Framework::Component,
std::string > 
- Public Types inherited from SurgSim::Framework::Accessible
typedef std::function
< boost::any(void)> 
typedef std::function< void(boost::any)> SetterType
typedef std::function
< YAML::Node(void)> 
typedef std::function< void(const
YAML::Node *)> 
- 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
getPoseComponent () const
 Get the PoseComponent for this component, constant access. More...

Detailed Description

Behaviors perform actions.

They can update components, facilitate communication between components, and create new components. They are updated periodicly by the BehaviorManager through update() call.

Constructor & Destructor Documentation

SurgSim::Framework::Behavior::Behavior ( const std::string &  name)
virtual SurgSim::Framework::Behavior::~Behavior ( )

Member Function Documentation

virtual int SurgSim::Framework::Behavior::getTargetManagerType ( ) const
virtual void SurgSim::Framework::Behavior::update ( double  dt)
pure virtual

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