SurgSim::Framework::TransferPropertiesBehavior Class Reference

Behavior to copy properties between instances of Accessible. More...

`#include <SurgSim/Framework/TransferPropertiesBehavior.h>`

Inheritance diagram for SurgSim::Framework::TransferPropertiesBehavior:

## Public Member Functions

| TransferPropertiesBehavior (const std::string &name)
| Constructor. More...
virtual | ~TransferPropertiesBehavior ()
| Destructor. More...
bool | connect (std::shared_ptr< SurgSim::Framework::Accessible > sourceAccessible, const std::string &sourcePropertyName, std::shared_ptr< SurgSim::Framework::Accessible > tagetAccessible, const std::string &targetPropertyName)
| Connect two properties of two instances of accessible, once connected the value of the property will be copied from source to target at every update call. More...
bool | connect (const Property &source, const Property &target)
| Connect two properties of two instances of accessible, once connected the value of the property will be copied from source to target at every update call. More...
void | setTargetManagerType (int managerType)
| Sets the type of manager that this behavior should use, this cannot be done after initialization has occurred. More...
int | getTargetManagerType () const override
| Specifies which manger will handle this behavior. More...
void | update (double dt) override
| Update the behavior. More...
Public Member Functions inherited from SurgSim::Framework::Behavior
| Behavior (const std::string &name)
virtual | ~Behavior ()
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...
std::string | getFullName () const
| Gets a string containing the name of the Component and (if it has one) its SceneElement. 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 | retire ()
| Retire this component, this will be called when the component is removed from the ComponentManager that is responsible for handling this component. More...
void | setScene (std::weak_ptr< Scene > scene)
| Sets the scene. More...
std::shared_ptr< Scene > | getScene ()
| Gets the scene. More...
void | setSceneElement (std::weak_ptr< SceneElement > sceneElement)
| Sets the scene element. More...
std::shared_ptr< SceneElement > | getSceneElement ()
| Gets the scene element. More...
std::shared_ptr< const SceneElement > | getSceneElement () const
| Gets the scene element, constant version. More...
std::shared_ptr< Runtime > | getRuntime () 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< Component > | getSharedPtr ()
| Gets a shared pointer to this component. More...
virtual void | doRetire ()
| Interface to be implemented by derived classes Has a default implementation, does nothing. 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 >
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...
void | setDecoder (const std::string &name, DecoderType decoder)
| Sets the functions used to convert data from a YAML::Node. More...
YAML::Node | encode () const
| Encode this Accessible to a YAML::Node. More...
void | decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
| 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 Types

typedef std::pair< Property, Property > | Connection
| Local typedefs. More...

## Private Member Functions

bool | doInitialize () override
bool | doWakeUp () override

## Private Attributes

std::vector< Connection > | m_connections
| List of connections in this object. More...
boost::mutex | m_incomingMutex
| Lock for adding new connections. More...
std::vector< Connection > | m_incomingConnections
| Queue for adding new connections. More...
int | m_targetManager
| The manager type that will handle this behavior. More...

## Additional Inherited Members

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 Types inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
typedef ObjectFactory1< Component, std::string > | FactoryType
Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< Component, std::string >
static FactoryType & | getFactory ()
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

Behavior to copy properties between instances of Accessible.

Note
  HS-2013-dec-12 does not support removal of connections yes

## Member Typedef Documentation

## Connection

typedef std::pair<Property, Property> SurgSim::Framework::TransferPropertiesBehavior::Connection

private

Local typedefs.

## Constructor & Destructor Documentation

## TransferPropertiesBehavior()

SurgSim::Framework::TransferPropertiesBehavior::TransferPropertiesBehavior | ( | const std::string & | name | ) |

explicit

Constructor.

Parameters

  name | The name of the behavior.

## ~TransferPropertiesBehavior()

SurgSim::Framework::TransferPropertiesBehavior::~TransferPropertiesBehavior | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## connect() [1/2]

bool SurgSim::Framework::TransferPropertiesBehavior::connect | ( | std::shared_ptr< SurgSim::Framework::Accessible > | sourceAccessible,
|  | const std::string & | sourcePropertyName,
|  | std::shared_ptr< SurgSim::Framework::Accessible > | tagetAccessible,
|  | const std::string & | targetPropertyName
| ) |  |

Connect two properties of two instances of accessible, once connected the value of the property will be copied from source to target at every update call.

Precondition
  pointers cannot be nullptr, properties need to exist and the property at the source needs to be readable and the property at the target needs to be writeable

Parameters

  sourceAccessible | Source Accessible instance.
  sourcePropertyName | The name of the source property.
  tagetAccessible | Target Accessible instance.
  targetPropertyName | The name of the target property.

Returns
  true if the connection was created

## connect() [2/2]

bool SurgSim::Framework::TransferPropertiesBehavior::connect | ( | const Property & | source,
|  | const Property & | target
| ) |  |

Connect two properties of two instances of accessible, once connected the value of the property will be copied from source to target at every update call.

Precondition
  pointers cannot be nullptr, properties need to exist and the property at the source needs to be readable and the property at the target needs to be writeable

Parameters

  source | Source property.
  target | Target property.

Returns
  true if the connection was created

## doInitialize()

bool SurgSim::Framework::TransferPropertiesBehavior::doInitialize | ( |  | ) |

override private virtual

Overridden from Behavior

Implements SurgSim::Framework::Component.

## doWakeUp()

bool SurgSim::Framework::TransferPropertiesBehavior::doWakeUp | ( |  | ) |

override private virtual

Overridden from Behavior

Implements SurgSim::Framework::Component.

## getTargetManagerType()

int SurgSim::Framework::TransferPropertiesBehavior::getTargetManagerType | ( |  | ) | const

override virtual

Specifies which manger will handle this behavior.

Reimplemented from SurgSim::Framework::Behavior.

## setTargetManagerType()

void SurgSim::Framework::TransferPropertiesBehavior::setTargetManagerType | ( | int | managerType | ) |

Sets the type of manager that this behavior should use, this cannot be done after initialization has occurred.

Parameters

  managerType | Type of manager for this behavior

## update()

void SurgSim::Framework::TransferPropertiesBehavior::update | ( | double | dt | ) |

override virtual

Update the behavior.

Parameters

  dt | The length of time (seconds) between update calls.

Implements SurgSim::Framework::Behavior.

## Member Data Documentation

## m_connections

std::vector<Connection> SurgSim::Framework::TransferPropertiesBehavior::m_connections

private

List of connections in this object.

## m_incomingConnections

std::vector<Connection> SurgSim::Framework::TransferPropertiesBehavior::m_incomingConnections

private

Queue for adding new connections.

## m_incomingMutex

boost::mutex SurgSim::Framework::TransferPropertiesBehavior::m_incomingMutex

private

Lock for adding new connections.

## m_targetManager

int SurgSim::Framework::TransferPropertiesBehavior::m_targetManager

private

The manager type that will handle this behavior.

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

- SurgSim/Framework/TransferPropertiesBehavior.h
- SurgSim/Framework/TransferPropertiesBehavior.cpp