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

Report Class Reference
[Utilities]

Inherited by HtmlReport.


Detailed Description

baseclass for special report objects

Author:
Ralf Gerstenberger

See also:
Table TableDefinition ReportProducer
Report is the base class for user defined report objects. Report manages Tables, ReportProducer and the report generation. Each Report object represents an individual report. There can be multiple reports in a simulation.

Since:
1.0


Public Member Functions

 Report ()
 Construction.

 ~Report ()
 Destruction.

void generateReport ()
 generate report

Table management
TablecreateTable (const char *name, TableDefinition *def)
 create a Table

TablecreateTable (const std::string &name, TableDefinition *def)
 create a Table

TablefindTable (TableDefinition *def, const char *name)
 find a Table

ReportProducer handling
void addProducer (ReportProducer *rp)
 add ReportProducer rp to this Report

void removeProducer (ReportProducer *rp)
 remove ReportProducer rp from this Report


Protected Member Functions

virtual void processTables ()=0
 process Tables in this Report


Protected Attributes

std::vector< Table * > ts
 contained Tables


Member Function Documentation

Table* createTable const char *  name,
TableDefinition def
 

create a Table

Parameters:
name name of new Table
def TableDefinition of new Table
Returns:
new Table
Note:
If there is already a Table with an equal name and definition it will be returned instead of creating a new Table.

Table* createTable const std::string &  name,
TableDefinition def
 

create a Table

Parameters:
name name of new Table
def TableDefinition of new Table
Returns:
new Table
Note:
If there is already a Table with an equal name and definition it will be returned instead of creating a new Table.

Table* findTable TableDefinition def,
const char *  name
 

find a Table

Parameters:
name name of Table
def TableDefinition of Table
Returns:
found Table or 0

void generateReport  ) 
 

generate report

Report generation:

  1. call all ReportProducer
  2. call processTables

virtual void processTables  )  [protected, pure virtual]
 

process Tables in this Report

Report objects have to provide a meaningful processTables() function.

Implemented in HtmlReport.


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