An automatically generated class. More...

#include <SimulationState.hxx>

Public Types
enum	Type { HoldCurrent , Advance , Replay , Inactive , Inactive_HoldCurrent , Calibrate_HoldCurrent , Advance_HoldCurrent , Replay_HoldCurrent , HoldCurrent_Inactive , Neutral , Undefined }
	Enumerated type for an automatically generated object class. More...

typedef SimulationState	__ThisDCOType__
	typedef for internal reference

Public Member Functions
	SimulationState ()
	default constructor.

	SimulationState (const Type &t)
	Constructor with arguments.

	SimulationState (const SimulationState &o)
	copy constructor.

	SimulationState (::dueca::AmorphReStore &r)
	constructor to restore an SimulationState from amorphous storage.

	~SimulationState ()
	destructor.

void	packData (::dueca::AmorphStore &s) const
	packs the SimulationState into amorphous storage.

void	packDataDiff (::dueca::AmorphStore &s, const SimulationState &ref) const
	packs the SimulationState into amorphous storage. More...

void	unPackData (::dueca::AmorphReStore &s)
	unpacks the SimulationState from an amorphous storage.

void	unPackDataDiff (::dueca::AmorphReStore &s)
	unpacks the differences for SimulationState from an amorphous storage.

bool	operator== (const SimulationState &o) const
	Test for equality.

bool	operator!= (const SimulationState &o) const
	Test for inequality.

SimulationState &	operator= (const SimulationState &o)
	Assignment operator.

std::ostream &	print (std::ostream &s) const
	prints the SimulationState to a stream.

Static Public Member Functions
static void *	operator new (size_t size)
	new operator "new", which places objects not on a heap, but in one of the memory arenas. More...

static void	operator delete (void *p)
	new operator "delete", to go with the new version of operator new.

static void *	operator new (size_t size, SimulationState *&o)
	placement "new", needed for stl.

Static Public Attributes
static const char *const	classname
	The name of this class.

static const uint32_t	magic_check_number
	a "magic" number, hashed out of the class definition, that will be used to check consistency of the sent objects across the dueca nodes.

Detailed Description

An automatically generated class.

Member Enumeration Documentation

Enumerated type for an automatically generated object class.

Enumerator
HoldCurrent	A state, shared between the SimulationModule and HardwareModule. The simulation is poised to start.
Advance	In this state, the simulation is running.
Replay	In this state, the simulation is played again with recorded input. Most modules can simply run their Advance code for this Todo: The replay functionality has not yet been implemented.
Inactive	A state, exclusive for HardwareModule, in which the hardware is in the safe position, but not error code.
Inactive_HoldCurrent	Transition from inactive to HoldCurrent, for example lifting the simulator cab to neutral position.
Calibrate_HoldCurrent	A transition state during which calibration is carried out. After calibration the state transitions to HoldCurrent.
Advance_HoldCurrent	A transition state from Advance, participation in the simulation, back to HoldCurrent. Transitional State.
Replay_HoldCurrent	A transition state from Replay, back to HoldCurrent.
HoldCurrent_Inactive	A transition from HoldCurrent to inactive, for example going down.
Neutral	Not a state, for initialising combination.
Undefined	Undefined.

static void * dueca::SimulationState::operator new ( size_t size )

static

new operator "new", which places objects not on a heap, but in one of the memory arenas.

This to speed up memory management.

void dueca::SimulationState::packDataDiff	(	::dueca::AmorphStore &	s,
		const SimulationState &	ref
	)		const

packs the SimulationState into amorphous storage.

only differences with a previous object are packed.

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

/home/abuild/rpmbuild/BUILD/dueca-4.0.2/redhat-linux-build/dueca/SimulationState.hxx