DUECA/DUSIME
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
dueca::SnapshotState Struct Reference

Enum event type for keeping snapshot info. More...

Public Types

enum  Type {
  SnapClear, SnapPrepared, SnapNow, SnapTaken,
  SnapSendNotApplicable, SnapSent, SnapLoaded, SnapNotFilled,
  TooLateForSnap
}
 Enum type for the different snapshot states and commands. More...
 
typedef SnapshotState __ThisDCOType__
 typedef for internal reference
 

Public Member Functions

 SnapshotState ()
 default constructor. More...
 
 SnapshotState (const Type &state)
 Constructor with arguments.
 
 SnapshotState (const SnapshotState &o)
 copy constructor. More...
 
 SnapshotState (::dueca::AmorphReStore &r)
 constructor to restore an SnapshotState from amorphous storage. More...
 
 ~SnapshotState ()
 destructor. More...
 
void packData (::dueca::AmorphStore &s) const
 packs the SnapshotState into amorphous storage. More...
 
void packDataDiff (::dueca::AmorphStore &s, const SnapshotState &ref) const
 packs the SnapshotState into amorphous storage. More...
 
void unPackData (::dueca::AmorphReStore &s)
 unpacks the SnapshotState from an amorphous storage. More...
 
void unPackDataDiff (::dueca::AmorphReStore &s)
 unpacks the differences for SnapshotState from an amorphous storage. More...
 
bool operator== (const SnapshotState &o) const
 Test for equality. More...
 
bool operator!= (const SnapshotState &o) const
 Test for inequality. More...
 
SnapshotStateoperator= (const SnapshotState &o)
 Assignment operator. More...
 
std::ostream & print (std::ostream &s) const
 prints the SnapshotState to a stream. 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, SnapshotState *&o)
 placement "new", needed for stl. More...
 

Public Attributes

Type state
 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...
 

Detailed Description

Enum event type for keeping snapshot info.

Member Enumeration Documentation

◆ Type

Enum type for the different snapshot states and commands.

Enumerator
SnapClear 

clear memory used for snapshot

SnapPrepared 

prepared module for taking snapshot

SnapNow 

take the snapshot at the indicated time

SnapTaken 

confirm the snapshot has been taken

SnapSendNotApplicable 

say this module does not send a snapshot

SnapSent 

confirm snapshot has been sent off

SnapLoaded 

confirm snapshot data has been re-loaded

SnapNotFilled 

complain no data available

TooLateForSnap 

command came too late

Constructor & Destructor Documentation

◆ SnapshotState() [1/3]

dueca::SnapshotState::SnapshotState ( )

default constructor.

◆ SnapshotState() [2/3]

dueca::SnapshotState::SnapshotState ( const SnapshotState o)

copy constructor.

◆ SnapshotState() [3/3]

dueca::SnapshotState::SnapshotState ( ::dueca::AmorphReStore r)

constructor to restore an SnapshotState from amorphous storage.

◆ ~SnapshotState()

dueca::SnapshotState::~SnapshotState ( )

destructor.

Member Function Documentation

◆ operator new() [1/2]

static void* dueca::SnapshotState::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.

◆ operator delete()

static void dueca::SnapshotState::operator delete ( void *  p)
static

new operator "delete", to go with the new version of operator new.

◆ operator new() [2/2]

static void* dueca::SnapshotState::operator new ( size_t  size,
SnapshotState *&  o 
)
inlinestatic

placement "new", needed for stl.

◆ packData()

void dueca::SnapshotState::packData ( ::dueca::AmorphStore s) const

packs the SnapshotState into amorphous storage.

◆ packDataDiff()

void dueca::SnapshotState::packDataDiff ( ::dueca::AmorphStore s,
const SnapshotState ref 
) const

packs the SnapshotState into amorphous storage.

only differences with a previous object are packed.

◆ unPackData()

void dueca::SnapshotState::unPackData ( ::dueca::AmorphReStore s)

unpacks the SnapshotState from an amorphous storage.

◆ unPackDataDiff()

void dueca::SnapshotState::unPackDataDiff ( ::dueca::AmorphReStore s)

unpacks the differences for SnapshotState from an amorphous storage.

◆ operator==()

bool dueca::SnapshotState::operator== ( const SnapshotState o) const

Test for equality.

◆ operator!=()

bool dueca::SnapshotState::operator!= ( const SnapshotState o) const
inline

Test for inequality.

◆ operator=()

SnapshotState& dueca::SnapshotState::operator= ( const SnapshotState o)

Assignment operator.

◆ print()

std::ostream& dueca::SnapshotState::print ( std::ostream &  s) const

prints the SnapshotState to a stream.

Member Data Documentation

◆ classname

const char* const dueca::SnapshotState::classname
static

The name of this class.

◆ magic_check_number

const uint32_t dueca::SnapshotState::magic_check_number
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.


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