opensurgsim
Public Member Functions | Protected Attributes | List of all members
SurgSim::Physics::MockRepresentation Class Reference
Inheritance diagram for SurgSim::Physics::MockRepresentation:
SurgSim::Physics::Representation SurgSim::Framework::Representation SurgSim::Framework::Component SurgSim::Framework::Accessible SurgSim::Framework::FactoryBase1< Component, std::string >

Public Member Functions

 MockRepresentation (const std::string &name="MockRepresention")
 
 SURGSIM_CLASSNAME (SurgSim::Physics::MockRepresentation)
 
void beforeUpdate (double dt) override
 Preprocessing done before the update call. More...
 
void update (double dt) override
 Update the representation state to the current time step. More...
 
void afterUpdate (double dt) override
 Postprocessing done after the update call. More...
 
int getPreUpdateCount () const
 
int getUpdateCount () const
 
int getPostUpdateCount () const
 
std::shared_ptr< LocalizationcreateLocalization (const SurgSim::DataStructures::Location &location) override
 Computes a localized coordinate w.r.t this representation, given a Location object. More...
 
- Public Member Functions inherited from SurgSim::Physics::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual ~Representation ()
 Destructor.
 
virtual void resetState ()
 Reset the representation to its initial/default state.
 
size_t getNumDof () const
 Query the object number of degrees of freedom. More...
 
void setIsGravityEnabled (bool isGravityEnabled)
 Set the gravity enable flag. More...
 
bool isGravityEnabled () const
 Get the gravity enable flag. More...
 
void setIsDrivingSceneElementPose (bool isDrivingSceneElementPose)
 Set whether this Representation is controlling the pose of the SceneElement that it is part of. More...
 
bool isDrivingSceneElementPose ()
 Query if this Representation is controlling the pose of the SceneElement that it is part of. More...
 
virtual void applyCorrection (double dt, const Eigen::VectorBlock< SurgSim::Math::Vector > &deltaVelocity)
 Update the Representation's current position and velocity using a time interval, dt, and change in velocity, deltaVelocity. More...
 
std::shared_ptr< SurgSim::Collision::RepresentationgetCollisionRepresentation () const
 
virtual void setCollisionRepresentation (std::shared_ptr< SurgSim::Collision::Representation > representation)
 Set the collision representation for this physics representation, when the collision object is involved in a collision, the collision should be resolved inside the dynamics calculation. More...
 
std::shared_ptr< ConstraintImplementationgetConstraintImplementation (SurgSim::Physics::ConstraintType type)
 Get a constraint implementation of the given type for this representation. More...
 
- Public Member Functions inherited from SurgSim::Framework::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual void setLocalPose (const SurgSim::Math::RigidTransform3d &pose)
 Set the pose of the representation with respect to the Scene Element. More...
 
virtual SurgSim::Math::RigidTransform3d getLocalPose () const
 Get the pose of the representation with respect to the Scene Element. More...
 
virtual SurgSim::Math::RigidTransform3d getPose () const
 Get the pose of the representation in world coordinates. More...
 
- Public Member Functions inherited from SurgSim::Framework::Component
 Component (const std::string &name)
 Constructor. More...
 
virtual ~Component ()
 Destructor.
 
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.
 
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< 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 SceneElementgetSceneElement () 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 void doRetire ()
 Interface to be implemented by derived classes Has a default implementation, does nothing.
 
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.
 
 ~Accessible ()
 Destructor.
 
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...
 
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...
 
std::vector< std::string > getProperties ()
 
template<>
boost::any getValue (const std::string &name) const
 

Protected Attributes

int m_preUpdateCount
 
int m_updateCount
 
int m_postUpdateCount
 
- Protected Attributes inherited from SurgSim::Physics::Representation
std::shared_ptr< SurgSim::Collision::Representationm_collisionRepresentation
 This entity's collision representation, these are usually very specific to the physics representation.
 
std::shared_ptr< SurgSim::Framework::Loggerm_logger
 Logger for this class.
 

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 FactoryTypegetFactory ()
 
- Protected Member Functions inherited from SurgSim::Physics::Representation
void setNumDof (size_t numDof)
 Set the number of degrees of freedom. More...
 
const SurgSim::Math::Vector3dgetGravity () const
 Get the gravity used by this Representation. More...
 
void driveSceneElementPose (const SurgSim::Math::RigidTransform3d &pose)
 This conditionally updates that pose for the scenelement to the given pose The update gets exectuded if the representation actually has sceneelement and isDrivingScenElement() is true. More...
 
- Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr< PoseComponentgetPoseComponent ()
 Get the PoseComponent for this component. More...
 
virtual std::shared_ptr< const PoseComponentgetPoseComponent () const
 Get the PoseComponent for this component, constant access. More...
 

Member Function Documentation

§ afterUpdate()

void MockRepresentation::afterUpdate ( double  dt)
overridevirtual

Postprocessing done after the update call.

Parameters
dtThe time step (in seconds)

Reimplemented from SurgSim::Physics::Representation.

§ beforeUpdate()

void MockRepresentation::beforeUpdate ( double  dt)
overridevirtual

Preprocessing done before the update call.

Parameters
dtThe time step (in seconds)

Reimplemented from SurgSim::Physics::Representation.

§ createLocalization()

std::shared_ptr< Localization > MockRepresentation::createLocalization ( const SurgSim::DataStructures::Location location)
overridevirtual

Computes a localized coordinate w.r.t this representation, given a Location object.

Parameters
locationA location in 3d space.
Returns
A localization object for the given location.

Reimplemented from SurgSim::Physics::Representation.

§ update()

void MockRepresentation::update ( double  dt)
overridevirtual

Update the representation state to the current time step.

Parameters
dtThe time step (in seconds)

Reimplemented from SurgSim::Physics::Representation.


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