DUECA/DUSIME
|
An automatically generated class. More...
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. More... | |
SimulationState (const Type &t) | |
Constructor with arguments. | |
SimulationState (const SimulationState &o) | |
copy constructor. More... | |
SimulationState (::dueca::AmorphReStore &r) | |
constructor to restore an SimulationState from amorphous storage. More... | |
~SimulationState () | |
destructor. More... | |
void | packData (::dueca::AmorphStore &s) const |
packs the SimulationState into amorphous storage. More... | |
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. More... | |
void | unPackDataDiff (::dueca::AmorphReStore &s) |
unpacks the differences for SimulationState from an amorphous storage. More... | |
bool | operator== (const SimulationState &o) const |
Test for equality. More... | |
bool | operator!= (const SimulationState &o) const |
Test for inequality. More... | |
SimulationState & | operator= (const SimulationState &o) |
Assignment operator. More... | |
std::ostream & | print (std::ostream &s) const |
prints the SimulationState to a stream. More... | |
SimulationState (const std::string &s) | |
Constructor from a string. | |
const char *const | getString () const |
Obtain a character representation. More... | |
Type | get () const |
Obtain the enumerated type. More... | |
SimulationState & | operator= (const SimulationState::Type &o) |
Assignment with type. | |
bool | operator== (const SimulationState::Type &o) const |
Test equality. | |
bool | operator!= (const SimulationState::Type &o) const |
Test inequality. | |
SimulationState | operator&& (const SimulationState &o) const |
Combine two states, into a new one. More... | |
SimulationState & | operator&= (const SimulationState &o) |
Combine and possibly change this state. More... | |
bool | betterOrSame (const SimulationState &o) const |
Returns true, if the state given in the argument is the same state or a "better" state (for example a final state, a compatible state) as the current one. More... | |
Type | transitionFinal () const |
Return the next state after a transitional state, so with transition complete. More... | |
void | neutral () |
Set to neutral/clear status. More... | |
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. More... | |
static void * | operator new (size_t size, SimulationState *&o) |
placement "new", needed for stl. More... | |
Public Attributes | |
Type | t |
the actual state | |
Static Public Attributes | |
static const char *const | classname |
The name of this class. More... | |
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. More... | |
An automatically generated class.
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
|
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. |
dueca::SimulationState::SimulationState | ( | ) |
default constructor.
dueca::SimulationState::SimulationState | ( | const SimulationState & | o | ) |
copy constructor.
dueca::SimulationState::SimulationState | ( | ::dueca::AmorphReStore & | r | ) |
constructor to restore an SimulationState from amorphous storage.
dueca::SimulationState::~SimulationState | ( | ) |
destructor.
|
static |
new operator "new", which places objects not on a heap, but in one of the memory arenas.
This to speed up memory management.
|
static |
new operator "delete", to go with the new version of operator new.
|
inlinestatic |
placement "new", needed for stl.
void dueca::SimulationState::packData | ( | ::dueca::AmorphStore & | s | ) | const |
packs the SimulationState into amorphous storage.
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.
void dueca::SimulationState::unPackData | ( | ::dueca::AmorphReStore & | s | ) |
unpacks the SimulationState from an amorphous storage.
void dueca::SimulationState::unPackDataDiff | ( | ::dueca::AmorphReStore & | s | ) |
unpacks the differences for SimulationState from an amorphous storage.
bool dueca::SimulationState::operator== | ( | const SimulationState & | o | ) | const |
Test for equality.
|
inline |
Test for inequality.
SimulationState& dueca::SimulationState::operator= | ( | const SimulationState & | o | ) |
Assignment operator.
std::ostream& dueca::SimulationState::print | ( | std::ostream & | s | ) | const |
prints the SimulationState to a stream.
const char* const dueca::SimulationState::getString | ( | ) | const |
Obtain a character representation.
|
inline |
Obtain the enumerated type.
SimulationState dueca::SimulationState::operator && | ( | const SimulationState & | o | ) | const |
Combine two states, into a new one.
SimulationState& dueca::SimulationState::operator &= | ( | const SimulationState & | o | ) |
Combine and possibly change this state.
bool dueca::SimulationState::betterOrSame | ( | const SimulationState & | o | ) | const |
Returns true, if the state given in the argument is the same state or a "better" state (for example a final state, a compatible state) as the current one.
o | Other state for comparison. |
Type dueca::SimulationState::transitionFinal | ( | ) | const |
Return the next state after a transitional state, so with transition complete.
|
inline |
Set to neutral/clear status.
|
static |
The name of this class.
|
static |
a "magic" number, hashed out of the class definition, that will be used to check consistency of the sent objects across the dueca nodes.