opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
opyn::ModelState Class Referencefinal

#include <model_state.h>

Public Types

using attrs_type = std::unordered_map< Symbol, double >
 

Public Member Functions

 ModelState ()
 Constructs an empty model state.
 
 ModelState (SimTK::State &&)
 
ModelStateStage stage () const
 Returns the ModelStateStage that this state has been realized to.
 
double time () const
 Returns the time point, in seconds, that this state represents.
 
const attrs_typeattrs () const
 Returns this ModelState's metadata (e.g. integrator stats, performance counters).
 
void set_attrs (attrs_type new_attrs)
 Sets the attrs of this ModelState to new_attrs.
 
const SimTK::State & simbody_state () const
 Returns the underlying SimTK::State (internal method: be careful with this).
 
SimTK::State & upd_simbody_state ()
 Returns the underlying SimTK::State (internal method: be careful with this).
 

Member Typedef Documentation

◆ attrs_type

using opyn::ModelState::attrs_type = std::unordered_map<Symbol, double>

Constructor & Destructor Documentation

◆ ModelState() [1/2]

opyn::ModelState::ModelState ( )

Constructs an empty model state.

◆ ModelState() [2/2]

opyn::ModelState::ModelState ( SimTK::State &&  )
explicit

Member Function Documentation

◆ attrs()

const attrs_type & opyn::ModelState::attrs ( ) const

Returns this ModelState's metadata (e.g. integrator stats, performance counters).

◆ set_attrs()

void opyn::ModelState::set_attrs ( attrs_type  new_attrs)

Sets the attrs of this ModelState to new_attrs.

◆ simbody_state()

const SimTK::State & opyn::ModelState::simbody_state ( ) const

Returns the underlying SimTK::State (internal method: be careful with this).

◆ stage()

ModelStateStage opyn::ModelState::stage ( ) const

Returns the ModelStateStage that this state has been realized to.

◆ time()

double opyn::ModelState::time ( ) const

Returns the time point, in seconds, that this state represents.

◆ upd_simbody_state()

SimTK::State & opyn::ModelState::upd_simbody_state ( )

Returns the underlying SimTK::State (internal method: be careful with this).


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