State of an entity.
More...
#include <physics/physics.hh>
Inherited by CollisionState, JointState, LightState, LinkState, ModelState, and WorldState.
State of an entity.
This is the base class for all State information.
Constructor.
Construct a State object using some basic information.
- Parameters
-
_name | Name associated with the State information. This is typically the name of an Entity. |
_realTime | Clock time since simulation started. |
_simTime | Simulation time associated with this State info. |
_iterations | Simulation iterations since simulation started. |
uint64_t GetIterations |
( |
| ) |
const |
Get the iterations when this state was generated.
- Returns
- Iterations when the data was recorded
std::string GetName |
( |
| ) |
const |
Get the name associated with this State.
- Returns
- Name associated with this state information. Typically a name of an Entity.
Get the real time when this state was generated.
- Returns
- Clock time since simulation was stated.
Get the sim time when this state was generated.
- Returns
- Simulation time when the data was recorded.
Get the wall time when this state was generated.
- Returns
- The absolute clock time when the State data was recorded.
virtual void Load |
( |
const sdf::ElementPtr |
_elem | ) |
|
|
virtual |
Subtraction operator.
- Parameters
-
[in] | _pt | A state to substract. |
- Returns
- The resulting state.
Assignment operator.
- Parameters
-
- Returns
- this
virtual void SetIterations |
( |
const uint64_t |
_iterations | ) |
|
|
virtual |
Set the iterations when this state was generated.
- Parameters
-
[in] | _iterations | Iterations when the data was recorded. |
Reimplemented in ModelState, WorldState, and LinkState.
void SetName |
( |
const std::string & |
_name | ) |
|
Set the name associated with this State.
- Parameters
-
[in] | _name | Name associated with this state information. Typically the name of an Entity. |
Set the real time when this state was generated.
- Parameters
-
[in] | _time | Clock time since simulation was stated. |
Reimplemented in ModelState, WorldState, and LinkState.
Set the sim time when this state was generated.
- Parameters
-
[in] | _time | Simulation time when the data was recorded. |
Reimplemented in ModelState, WorldState, and LinkState.
Set the wall time when this state was generated.
- Parameters
-
[in] | _time | The absolute clock time when the State data was recorded. |
Reimplemented in ModelState, WorldState, and LinkState.
The number of simulation iterations when this state was generated.
Name associated with this State.
Times for the state data.
The documentation for this class was generated from the following file: