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

Configuration message for DUECA logging. More...

Public Types

typedef DUECALogConfig __ThisDCOType__
 typedef for internal reference
 

Public Member Functions

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

Public Attributes

vstring filename
 File name pattern for creating a log, if empty, use previous or default file name. More...
 
vstring prefix
 path prefix for the logging. More...
 
vstring attribute
 attribute string that will be added to the log base point, for additional logging/condition information, if possible with the logger. More...
 

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

Configuration message for DUECA logging.

When configured to listen to config messages, the Logger will only start logging after such a message has been received.

Possible modes of operation:

Constructor & Destructor Documentation

◆ DUECALogConfig() [1/3]

dueca::DUECALogConfig::DUECALogConfig ( )

default constructor.

◆ DUECALogConfig() [2/3]

dueca::DUECALogConfig::DUECALogConfig ( const DUECALogConfig o)

copy constructor.

◆ DUECALogConfig() [3/3]

dueca::DUECALogConfig::DUECALogConfig ( ::dueca::AmorphReStore r)

constructor to restore an DUECALogConfig from amorphous storage.

◆ ~DUECALogConfig()

dueca::DUECALogConfig::~DUECALogConfig ( )

destructor.

Member Function Documentation

◆ operator new() [1/2]

static void* dueca::DUECALogConfig::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::DUECALogConfig::operator delete ( void *  p)
static

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

◆ operator new() [2/2]

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

placement "new", needed for stl.

◆ packData()

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

packs the DUECALogConfig into amorphous storage.

◆ packDataDiff()

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

packs the DUECALogConfig into amorphous storage.

only differences with a previous object are packed.

◆ unPackData()

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

unpacks the DUECALogConfig from an amorphous storage.

◆ unPackDataDiff()

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

unpacks the differences for DUECALogConfig from an amorphous storage.

◆ operator==()

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

Test for equality.

◆ operator!=()

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

Test for inequality.

◆ operator=()

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

Assignment operator.

◆ print()

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

prints the DUECALogConfig to a stream.

Member Data Documentation

◆ classname

const char* const dueca::DUECALogConfig::classname
static

The name of this class.

◆ filename

vstring dueca::DUECALogConfig::filename

File name pattern for creating a log, if empty, use previous or default file name.

;; This uses boost::posix_time to fill any patterns with time and/or date information. Possible patterns include Y m d H M S for year, month, day, hour, minute and second, respectively.

◆ prefix

vstring dueca::DUECALogConfig::prefix

path prefix for the logging.

Can be used to log multiple sets in a single file. If empty, no prefix is used

◆ attribute

vstring dueca::DUECALogConfig::attribute

attribute string that will be added to the log base point, for additional logging/condition information, if possible with the logger.

If the prefix is empty, this is attribute is attached to the file root group, otherwise to the chosen prefix.

◆ magic_check_number

const uint32_t dueca::DUECALogConfig::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: