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.
§ State() [1/2]
§ State() [2/2]
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. |
§ ~State()
§ GetIterations()
uint64_t GetIterations |
( |
| ) |
const |
Get the iterations when this state was generated.
- Returns
- Iterations when the data was recorded
§ GetName()
std::string GetName |
( |
| ) |
const |
Get the name associated with this State.
- Returns
- Name associated with this state information. Typically a name of an Entity.
§ GetRealTime()
Get the real time when this state was generated.
- Returns
- Clock time since simulation was stated.
§ GetSimTime()
Get the sim time when this state was generated.
- Returns
- Simulation time when the data was recorded.
§ GetWallTime()
Get the wall time when this state was generated.
- Returns
- The absolute clock time when the State data was recorded.
§ Load()
virtual void Load |
( |
const sdf::ElementPtr |
_elem | ) |
|
|
virtual |
§ operator-()
Subtraction operator.
- Parameters
-
[in] | _pt | A state to substract. |
- Returns
- The resulting state.
§ operator=()
Assignment operator.
- Parameters
-
- Returns
- this
§ SetIterations()
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.
§ SetName()
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. |
§ SetRealTime()
Set the real time when this state was generated.
- Parameters
-
[in] | _time | Clock time since simulation was stated. |
Reimplemented in ModelState, WorldState, and LinkState.
§ SetSimTime()
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.
§ SetWallTime()
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.
§ iterations
The number of simulation iterations when this state was generated.
§ name
Name associated with this State.
§ realTime
§ simTime
§ wallTime
Times for the state data.
The documentation for this class was generated from the following file: