Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Data Structures   File List   Namespace Members   Data Fields   Globals   Related Pages   Examples  

Utilities


Detailed Description

Utility classes and functions of ODEMx.


Data Structures

class  LabeledObject
 LabeledObject is an interface that provides a label for an object. More...

class  LabelScope
 LabelScope provides a scope for a label. More...

class  DefLabeledObject
 DefLabeledObject is a default implementation of the LabeledObject interface. More...

class  Observable
 Observable provides management of Observer. More...

class  TableDefinition
 The table structure is defined by TableDefinition. More...

class  Table
 Container for reported data. More...

class  ReportProducer
 A ReportProducer generates data. More...

class  Report
 baseclass for special report objects More...

class  dynTableDefinition
 dynTableDefinition a TableDefinition implementation for dynamic definitions. More...

class  utTableDef
 utTableDef simplifies report table definitions More...

class  StatisticObject
 Abstract base class for statistic generating classes. More...

class  StatisticManager
 Management of StatisticObjects. More...

class  MarkType
 MarkType describes a trace mark. More...

class  Tag
 A Tag is used to build composed marks. More...

class  TraceProducer
 A TraceProducer generates marks that form the trace. More...

class  TraceConsumer
 A TraceConsumer receives marks from the Trace it is added to. More...

class  Trace
 The Trace receives marks from TraceProducer objects and informs registered TraceConsumer about these marks. More...

class  Version
 ODEMx version information. More...


Defines

#define _obsForEach(ObserverType, Event)
 Broadcast event.

#define _obsAForEach(ObserverType, Attribute, oldValue, newValue)
 Broadcast attribute change.


Enumerations

enum  ColumnType { INTEGER, REAL, STRING, INVALID }
 column types More...

enum  CtrlCode { ENDL, TAB }
 control codes More...


Functions

void debug (const char *message)
 debug() writes debug messages in debug mode

void warning (const char *message)
 warning() writes the message to stderr and continues;

void error (const char *message)
 error() writes the message to stderr and continues;

void fatalError (const char *message, int exitValue)
 fatalError() writes the message to stderr and terminates the program;

bool operator== (const TableDefinition &f, const TableDefinition &s)
 compare two TableDefinitions


Define Documentation

#define _obsForEach ObserverType,
Event   ) 
 

Value:

{\
        for(std::list<ObserverType* >::const_iterator i=Observable<ObserverType >::getObserver().begin();\
                i!=Observable<ObserverType >::getObserver().end(); ++i) (*i)->on##Event;\
}
Broadcast event.

Parameters:
ObserverType Type of observer (xxxObserver)
Event Event handler function without on ( Create(this) -> onCreate(this) )

#define _obsAForEach ObserverType,
Attribute,
oldValue,
newValue   ) 
 

Value:

{\
        for(std::list<ObserverType* >::const_iterator i=Observable<ObserverType >::getObserver().begin();\
                i!=Observable<ObserverType >::getObserver().end(); ++i) (*i)->onChange##Attribute(this, oldValue, newValue);\
}
Broadcast attribute change.

Parameters:
ObserverType Type of observer (xxxObserver)
Attribute Changed attribute name
oldValue Old value of attribute
newValue New value of attribute


Enumeration Type Documentation

enum ColumnType
 

column types

All columns in tables are associated to a data type.

Enumeration values:
INTEGER  integer numbers
REAL  real numbers
STRING  text
INVALID  used for undefined columns

enum CtrlCode
 

control codes

This control codes are used for operator << input into tables.

Enumeration values:
ENDL  end of table line
TAB  skip column


Function Documentation

void debug const char *  message  ) 
 

debug() writes debug messages in debug mode

Parameters:
message debug message as const char*
Note:
use the macro _debugOut(message) instead, to skip the function call in the release build

void warning const char *  message  ) 
 

warning() writes the message to stderr and continues;

This function is used to inform the user about unusual events, that indicate an user error.

Parameters:
message warning description as const char*

void error const char *  message  ) 
 

error() writes the message to stderr and continues;

This function reports errors, caused by wrong usage and internal errors, the system could handle. The behaviour of the simulation could be wrong after an error() is reported.

Parameters:
message error description as const char*

void fatalError const char *  message,
int  exitValue
 

fatalError() writes the message to stderr and terminates the program;

This function reports errors, caused by wrong usage and internal errors, the system can't handle.

Parameters:
message error description as const char*
exitValue exit value of program

bool operator== const TableDefinition f,
const TableDefinition s
 

compare two TableDefinitions

Returns:
true if number of columns, all labels and all types are equal


Generated on Mon Aug 11 10:36:06 2003 for ODEMx by doxygen1.3