CReport Class Reference

#include <CReport.h>

Inheritance diagram for CReport:

List of all members.

Public Member Functions
	CReport ()
	CReport (const CReport &src)
void	cleanup ()
	~CReport ()
virtual bool	compile (std::vector< CCopasiContainer * > listOfContainer, const CCopasiDataModel *pDataModel)
virtual void	output (const Activity &activity)
virtual void	separate (const Activity &)
virtual void	finish ()
CReportDefinition *	getReportDefinition ()
std::ostream *	open (const CCopasiDataModel *pDataModel, std::ostream *pOstream=NULL)
std::ostream *	getStream () const
void	setReportDefinition (CReportDefinition *reportDef)
const std::string &	getTarget () const
void	setTarget (std::string target)
bool	append () const
void	setAppend (bool append)

---

Constructor & Destructor Documentation

CReport::CReport

(

)

Default constructor.

CReport::CReport

(

const CReport &

src

)

Copy constructor.

Parameters:

const

CReport & src

CReport::~CReport

(

)

Destructor.

---

Member Function Documentation

bool CReport::append

(

)

const

Returns whether the Report Tag is appended or not

void CReport::cleanup

(

)

cleanup

bool CReport::compile	(	std::vector< CCopasiContainer * >	listOfContainer,
		const CCopasiDataModel *	pDataModel
	)		[virtual]

compile the object list from name vector

Parameters:

std::vector<	CCopasiContainer * > listOfContainer
const	CCopasiDataModel* pDataModel

Returns:

bool success

Reimplemented from COutputInterface.

void CReport::finish

(

)

[virtual]

Finish the output

Reimplemented from COutputInterface.

CReportDefinition * CReport::getReportDefinition

(

)

returns the reference of the Report Tag

std::ostream * CReport::getStream

(

)

const

Retrieve a pointer to the ostream

Returns:

std::ostream * pOstream

const std::string & CReport::getTarget

(

)

const

returns the target of the Report Tag

std::ostream * CReport::open	(	const CCopasiDataModel *	pDataModel,
		std::ostream *	pOstream = NULL
	)

Open the defined target stream or use the given argument

Parameters:

const	CCopasiDataModel * pDataModel,
std::ostream	* pOstream (default: NULL)

Returns:

std::ostream * mpOstream

void CReport::output

(

const Activity &

activity

)

[virtual]

Perform an output event for the current activity

Parameters:

const

Activity & activity

Reimplemented from COutputInterface.

void CReport::separate

(

const Activity &

)

[virtual]

Introduce an additional separator into the output

Parameters:

const

Activity & activity

Reimplemented from COutputInterface.

void CReport::setAppend

(

bool

append

)

sets the append attribute if the report tag

void CReport::setReportDefinition

(

CReportDefinition *

reportDef

)

sets the reference to the report

void CReport::setTarget

(

std::string

target

)

sets the reference to the report

---

The documentation for this class was generated from the following files:

• copasi/report/CReport.h
• copasi/report/CReport.cpp