Ignition Physics

API Reference

2.3.0
GetBasicJointState::Implementation< PolicyT > Class Template Referenceabstract

The implementation API for getting basic joint state. More...

#include <Joint.hh>

Public Types

using Pose = typename FromPolicy< PolicyT >::template Use< Pose >
 
using Scalar = typename PolicyT::Scalar
 

Public Member Functions

virtual Scalar GetJointAcceleration (const Identity &_id, std::size_t _dof) const =0
 
virtual Scalar GetJointForce (const Identity &_id, std::size_t _dof) const =0
 
virtual Scalar GetJointPosition (const Identity &_id, std::size_t _dof) const =0
 
virtual Pose GetJointTransform (const Identity &_id) const =0
 
virtual Scalar GetJointVelocity (const Identity &_id, std::size_t _dof) const =0
 
- Public Member Functions inherited from Feature::Implementation< PolicyT >
virtual ~Implementation ()=default
 Virtual destructor. More...
 
virtual Identity InitiateEngine (std::size_t engineID=0)=0
 Tell the physics plugin to initiate a physics engine. More...
 

Detailed Description

template<typename PolicyT>
class ignition::physics::GetBasicJointState::Implementation< PolicyT >

The implementation API for getting basic joint state.

Member Typedef Documentation

◆ Pose

using Pose = typename FromPolicy<PolicyT>::template Use<Pose>

◆ Scalar

using Scalar = typename PolicyT::Scalar

Member Function Documentation

◆ GetJointAcceleration()

virtual Scalar GetJointAcceleration ( const Identity &  _id,
std::size_t  _dof 
) const
pure virtual

◆ GetJointForce()

virtual Scalar GetJointForce ( const Identity &  _id,
std::size_t  _dof 
) const
pure virtual

◆ GetJointPosition()

virtual Scalar GetJointPosition ( const Identity &  _id,
std::size_t  _dof 
) const
pure virtual

◆ GetJointTransform()

virtual Pose GetJointTransform ( const Identity &  _id) const
pure virtual

◆ GetJointVelocity()

virtual Scalar GetJointVelocity ( const Identity &  _id,
std::size_t  _dof 
) const
pure virtual

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