All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Friends | 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.
 
 JointState (const sdf::ElementPtr _sdf)
 Constructor.
 
virtual ~JointState ()
 Destructor.
 
void FillSDF (sdf::ElementPtr _sdf)
 Populate a state SDF element with data from the object.
 
math::Angle GetAngle (unsigned int _axis) const
 Get the joint angle.
 
unsigned int GetAngleCount () const
 Get the number of angles.
 
const std::vector< math::Angle > & GetAngles () const
 Get the angles.
 
bool IsZero () const
 Return true if the values in the state are zero.
 
virtual void Load (const sdf::ElementPtr _elem)
 Load state from SDF element.
 
JointState operator+ (const JointState &_state) const
 Addition operator.
 
JointState operator- (const JointState &_state) const
 Subtraction operator.
 
JointStateoperator= (const JointState &_state)
 Assignment operator.
 
- 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.
 
State operator- (const State &_state) const
 Subtraction operator.
 
Stateoperator= (const State &_state)
 Assignment operator.
 
void SetName (const std::string &_name)
 Set the name associated with this State.
 

Friends

std::ostream & operator<< (std::ostream &_out, const gazebo::physics::JointState &_state)
 Stream insertion operator.
 

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.
gazebo::physics::JointState::JointState ( const sdf::ElementPtr  _sdf)
explicit

Constructor.

Build a JointState from SDF data

Parameters
[in]_sdfSDF data to load a joint state from.
virtual gazebo::physics::JointState::~JointState ( )
virtual

Destructor.

Member Function Documentation

void gazebo::physics::JointState::FillSDF ( sdf::ElementPtr  _sdf)

Populate a state SDF element with data from the object.

Parameters
[out]_sdfSDF element to populate.
math::Angle gazebo::physics::JointState::GetAngle ( unsigned int  _axis) const

Get the joint angle.

Parameters
[in]_axisThe axis index.
Returns
Angle of the axis.
Exceptions
common::ExceptionWhen _axis is invalid.
unsigned int gazebo::physics::JointState::GetAngleCount ( ) const

Get the number of angles.

Returns
The number of angles.
const std::vector<math::Angle>& gazebo::physics::JointState::GetAngles ( ) const

Get the angles.

Returns
Vector of angles.
bool gazebo::physics::JointState::IsZero ( ) const

Return true if the values in the state are zero.

Returns
True if the values in the state are zero.
virtual void gazebo::physics::JointState::Load ( const sdf::ElementPtr  _elem)
virtual

Load state from SDF element.

Parameters
[in]_elemSDf values to load from.

Reimplemented from gazebo::physics::State.

JointState gazebo::physics::JointState::operator+ ( const JointState _state) const

Addition operator.

Parameters
[in]_ptA state to add.
Returns
The resulting state.
JointState gazebo::physics::JointState::operator- ( const JointState _state) const

Subtraction operator.

Parameters
[in]_ptA state to substract.
Returns
The resulting state.
JointState& gazebo::physics::JointState::operator= ( const JointState _state)

Assignment operator.

Parameters
[in]_stateState value
Returns
this

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  _out,
const gazebo::physics::JointState _state 
)
friend

Stream insertion operator.

Parameters
[in]_outoutput stream.
[in]_stateJoint state to output.
Returns
The stream.

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