SimPT_Sim::SimState Class Reference

Contains the state of the whole Simulator at a given simulation step. More...

#include <SimState.h>

Collaboration diagram for SimPT_Sim::SimState:

Public Member Functions
MeshState	GetMeshState () const
	Get the state of the mesh.
boost::property_tree::ptree	GetParameters () const
	Returns the parameters currently used simulation model.
std::string	GetProjectName () const
	Returns the name of the associated project.
boost::property_tree::ptree	GetRandomEngineState () const
	Returns the state of the random engine in a ptree.
double	GetTime () const
	Returns the value of the current time step in seconds.
int	GetTimeStep () const
	Returns the index of the current time step.
void	PrintToStream (std::ostream &out) const
	Prints a text representation to the given output stream. More...
void	SetMeshState (MeshState const &mesh_state)
	Sets the current state of the mesh in the simulation.
void	SetParameters (boost::property_tree::ptree const &parameters)
	Sets the parameters currently used simulation model. More...
void	SetProjectName (std::string project_name)
	Sets the name of the associated project.
void	SetRandomEngineState (boost::property_tree::ptree const &re_state)
	Sets the state of the random number engine used for generating random in the simulation. More...
void	SetTime (double t)
	Sets the value of the current time step in seconds. More...
void	SetTimeStep (int step)
	Sets the index of the current time step. More...

Detailed Description

Contains the state of the whole Simulator at a given simulation step.

It's a data object to pass information for saving and loading.

Definition at line 33 of file SimState.h.

Member Function Documentation

void SimPT_Sim::SimState::PrintToStream

(

std::ostream &

out

)

const

Prints a text representation to the given output stream.

Parameters

[in,out]

out

The ouput stream to use for printing.

Note

This method is mainly used for debug purposes.

Definition at line 95 of file SimState.cpp.

References SimPT_Sim::MeshState::PrintToStream().

Here is the call graph for this function:

void SimPT_Sim::SimState::SetParameters

(

boost::property_tree::ptree const &

parameters

)

Sets the parameters currently used simulation model.

Parameters

parameters

Boost property tree of model parameters.

Definition at line 80 of file SimState.cpp.

Referenced by SimPT_Sim::Sim::GetState().

Here is the caller graph for this function:

void SimPT_Sim::SimState::SetRandomEngineState

(

boost::property_tree::ptree const &

re_state

)

Sets the state of the random number engine used for generating random in the simulation.

Definition at line 90 of file SimState.cpp.

Referenced by SimPT_Sim::Sim::GetState().

Here is the caller graph for this function:

void SimPT_Sim::SimState::SetTime

(

double

t

)

Sets the value of the current time step in seconds.

Parameters

t	Value of the current time step in seconds.

Definition at line 70 of file SimState.cpp.

Referenced by SimPT_Sim::Sim::GetState().

Here is the caller graph for this function:

void SimPT_Sim::SimState::SetTimeStep

(

int

step

)

Sets the index of the current time step.

Parameters

step	Index of the current time step.

Definition at line 65 of file SimState.cpp.

Referenced by SimPT_Sim::Sim::GetState().

Here is the caller graph for this function:

---

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

• SimState.h
• SimState.cpp