All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::physics::JointState Class Reference

keeps track of state of a physics::Joint More...

#include <physics/physics.hh>

Inheritance diagram for gazebo::physics::JointState:
Inheritance graph
[legend]

Public Member Functions

 JointState ()
 Default constructor.
 
 JointState (JointPtr _joint)
 Constructor.
 
virtual ~JointState ()
 Destructor.
 
math::Angle GetAngle (unsigned int _axis) const
 Get the joint angle.
 
unsigned int GetAngleCount () const
 Get the number of angles.
 
virtual void Load (sdf::ElementPtr _elem)
 Load state from SDF element.
 
- Public Member Functions inherited from gazebo::physics::State
 State ()
 Default constructor.
 
 State (const std::string &_name, const common::Time &_realTime, const common::Time &_simTime)
 Constructor.
 
virtual ~State ()
 Destructor.
 
std::string GetName () const
 Get the name associated with this State.
 
common::Time GetRealTime () const
 Get the real time when this state was generated.
 
common::Time GetSimTime () const
 Get the sim time when this state was generated.
 
common::Time GetWallTime () const
 Get the wall time when this state was generated.
 

Additional Inherited Members

- Protected Attributes inherited from gazebo::physics::State
std::string name
 Name associated with this State.
 
common::Time realTime
 
common::Time simTime
 
common::Time wallTime
 Times for the state data.
 

Detailed Description

keeps track of state of a physics::Joint

Constructor & Destructor Documentation

gazebo::physics::JointState::JointState ( )

Default constructor.

gazebo::physics::JointState::JointState ( JointPtr  _joint)
explicit

Constructor.

Parameters
[in]_jointJoint to get the state of.
virtual gazebo::physics::JointState::~JointState ( )
virtual

Destructor.

Member Function Documentation

math::Angle gazebo::physics::JointState::GetAngle ( unsigned int  _axis) const

Get the joint angle.

Parameters
[in]_axisThe axis index.
Returns
Angle of the axis.
unsigned int gazebo::physics::JointState::GetAngleCount ( ) const

Get the number of angles.

Returns
The number of angles.
virtual void gazebo::physics::JointState::Load ( sdf::ElementPtr  _elem)
virtual

Load state from SDF element.

Parameters
[in]_elemSDf values to load from.

Implements gazebo::physics::State.


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