Inheritance diagram for SurgSim::Physics::MockVirtualToolCoupler:
Public Member Functions | |
| const SurgSim::DataStructures::OptionalValue< double > & | getOptionalLinearStiffness () const |
| const SurgSim::DataStructures::OptionalValue< double > & | getOptionalLinearDamping () const |
| const SurgSim::DataStructures::OptionalValue< double > & | getOptionalAngularStiffness () const |
| const SurgSim::DataStructures::OptionalValue< double > & | getOptionalAngularDamping () const |
| const SurgSim::DataStructures::OptionalValue< SurgSim::Math::Vector3d > & | getOptionalAttachmentPoint () const |
| void | setOptionalLinearStiffness (const SurgSim::DataStructures::OptionalValue< double > &val) |
| void | setOptionalLinearDamping (const SurgSim::DataStructures::OptionalValue< double > &val) |
| void | setOptionalAngularStiffness (const SurgSim::DataStructures::OptionalValue< double > &val) |
| void | setOptionalAngularDamping (const SurgSim::DataStructures::OptionalValue< double > &val) |
| void | setOptionalAttachmentPoint (const SurgSim::DataStructures::OptionalValue< SurgSim::Math::Vector3d > &val) |
| const SurgSim::DataStructures::DataGroup & | getOutputData () const |
 Public Member Functions inherited from SurgSim::Physics::VirtualToolCoupler | |
| VirtualToolCoupler (const std::string &name) | |
| Constructor. More... | |
| SURGSIM_CLASSNAME (SurgSim::Physics::VirtualToolCoupler) | |
| const std::shared_ptr< Framework::Component > | getInput () |
| void | setInput (const std::shared_ptr< Framework::Component > input) |
| Set the Input Component. More... | |
| const std::shared_ptr< Framework::Component > | getOutput () |
| void | setOutput (const std::shared_ptr< Framework::Component > output) |
| Set the Output Component (if any) More... | |
| const std::shared_ptr< Framework::Component > | getRepresentation () |
| void | setRepresentation (const std::shared_ptr< Framework::Component > rigid) |
| Set the Physics Representation which follows the input. More... | |
| bool | isHapticOutputOnlyWhenColliding () const |
| Get whether or not the haptic forces should be provided only during collisions. More... | |
| void | setHapticOutputOnlyWhenColliding (bool haptic) |
| Set whether or not the haptic forces should be provided only during collisions. More... | |
| const std::string & | getPoseName () |
| void | setPoseName (const std::string &poseName=DataStructures::Names::POSE) |
| Set the name of the pose entry in the input DataGroup. More... | |
| void | update (double dt) override |
| Update the behavior. More... | |
| void | overrideLinearStiffness (double linearStiffness) |
| Override the linear stiffness connecting the input device and the physics representation If this value is not provided, the stiffness will be automatically tuned using the properties of the Representation. More... | |
| double | getLinearStiffness () |
| void | overrideLinearDamping (double linearDamping) |
| Override the linear damping connecting the input device and the physics representation If this value is not provided, the damping will be automatically tuned using the properties of the Representation. More... | |
| double | getLinearDamping () |
| void | overrideAngularStiffness (double angularStiffness) |
| Override the angular stiffness connecting the input device and the physics representation If this value is not provided, the stiffness will be automatically tuned using the properties of the Representation. More... | |
| double | getAngularStiffness () |
| void | overrideAngularDamping (double angularDamping) |
| Override the angular damping connecting the input device and the physics representation If this value is not provided, the damping will be automatically tuned using the properties of the Representation. More... | |
| double | getAngularDamping () |
| void | overrideAttachmentPoint (const Math::Vector3d &attachment) |
| Override the point of attachment to the Representation If this value is not provided, the point of attachment will be automatically set to the Representation's center of mass. More... | |
| const Math::Vector3d & | getAttachmentPoint () |
| Get the point of attachment on the Representation. More... | |
| void | setCalculateInertialTorques (bool calculateInertialTorques) |
| Enable/disable torques that simulate inertia. More... | |
| bool | getCalculateInertialTorques () const |
| Get whether the calculated torques will simulate inertia. More... | |
| void | setInitializeRigidWithInputPose (bool val) |
| Set whether the pose of the attached rigid is initialized with the first input pose received by the VTC this will 'teleport' the rigid into the first pose of the vtc. More... | |
| bool | isInitializingRigidWithInputPose () const |
| Get whether the pose of the attached rigid is initialized with the first input pose received by the VTC. More... | |
| void | doRetire () override |
| Interface to be implemented by derived classes Has a default implementation, does nothing. | |
| void | setLocalActive (bool val) override |
| Set the component's active state. More... | |
| Public Member Functions inherited from SurgSim::Framework::Behavior | |
| Behavior (const std::string &name) | |
| 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< 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... | |
| bool | isActive () const |
| bool | isLocalActive () const |
| Public Member Functions inherited from SurgSim::Framework::Accessible | |
| Accessible () | |
| Default Constructor. | |
| ~Accessible () | |
| Destructor. | |
| 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... | |
| std::vector< std::string > | getProperties () |
| template<> | |
| boost::any | getValue (const std::string &name) const |
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::Physics::VirtualToolCoupler | |
| bool | doInitialize () override |
| Interface to be implemented by derived classes. More... | |
| bool | doWakeUp () override |
| Interface to be implemented by derived classes. More... | |
| int | getTargetManagerType () const override |
| Specifies which manger will handle this behavior. | |
| void | setInitialInputPose (const SurgSim::Math::RigidTransform3d &pose) |
| virtual DataStructures::DataGroup | buildOutputData () |
| void | setOptionalLinearStiffness (const DataStructures::OptionalValue< double > &linearStiffness) |
| Used for Serialization. More... | |
| const DataStructures::OptionalValue< double > & | getOptionalLinearStiffness () const |
| Used for Serialization. More... | |
| void | setOptionalLinearDamping (const DataStructures::OptionalValue< double > &linearDamping) |
| Used for Serialization. More... | |
| const DataStructures::OptionalValue< double > & | getOptionalLinearDamping () const |
| Used for Serialization. More... | |
| void | setOptionalAngularStiffness (const DataStructures::OptionalValue< double > &angularStiffness) |
| Used for Serialization. More... | |
| const DataStructures::OptionalValue< double > & | getOptionalAngularStiffness () const |
| Used for Serialization. More... | |
| void | setOptionalAngularDamping (const DataStructures::OptionalValue< double > &angularDamping) |
| Used for Serialization. More... | |
| const DataStructures::OptionalValue< double > & | getOptionalAngularDamping () const |
| Used for Serialization. More... | |
| void | setOptionalAttachmentPoint (const DataStructures::OptionalValue< Math::Vector3d > &attachmentPoint) |
| Used for Serialization. More... | |
| const DataStructures::OptionalValue< Math::Vector3d > & | getOptionalAttachmentPoint () const |
| Used for Serialization. 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... | |
| Protected Attributes inherited from SurgSim::Physics::VirtualToolCoupler | |
| DataStructures::OptionalValue< double > | m_optionalLinearStiffness |
| User supplied Vtc stiffness parameter in linear mode (in N·m-1) | |
| DataStructures::OptionalValue< double > | m_optionalLinearDamping |
| User supplied Vtc damping parameter in linear mode (in N·s·m-1 or Kg·s-1) | |
| DataStructures::OptionalValue< double > | m_optionalAngularStiffness |
| User supplied Vtc stiffness parameter in angular mode (in N·m rad-1) | |
| DataStructures::OptionalValue< double > | m_optionalAngularDamping |
| User supplied Vtc damping parameter in angular mode (in N·m·s·rad-1) | |
| DataStructures::OptionalValue< Math::Vector3d > | m_optionalAttachmentPoint |
| User supplied attachment point. | |
| DataStructures::DataGroup | m_outputData |
| The DataGroup to output. | |
| std::shared_ptr< Input::InputComponent > | m_input |
| The input component. | |
| std::shared_ptr< Input::OutputComponent > | m_output |
| The output component. | |
The documentation for this class was generated from the following files:
- SurgSim/Physics/UnitTests/MockObjects.h
- SurgSim/Physics/UnitTests/MockObjects.cpp
