CReportDefinition Class Reference

#include <CReportDefinition.h>

Inheritance diagram for CReportDefinition:

List of all members.

Public Member Functions
	CReportDefinition (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
	CReportDefinition (const CReportDefinition &src, const CCopasiContainer *pParent=NULL)
	~CReportDefinition ()
void	cleanup ()
bool	preCompileTable (const std::vector< CCopasiContainer * > &listOfContainer=CCopasiContainer::EmptyList)
const std::string &	getComment () const
void	setComment (const std::string &comment)
std::vector < CRegisteredObjectName > *	getBodyAddr ()
std::vector < CRegisteredObjectName > *	getHeaderAddr ()
std::vector < CRegisteredObjectName > *	getFooterAddr ()
std::vector < CRegisteredObjectName > *	getTableAddr ()
bool	setTaskType (const CCopasiTask::Type &taskType)
const CCopasiTask::Type &	getTaskType () const
void	setSeparator (const CCopasiReportSeparator &Separator)
const CCopasiReportSeparator &	getSeparator () const
bool	getTitle () const
void	setTitle (bool title)
bool	isTable () const
void	setIsTable (bool table)
void	setPrecision (const unsigned C_INT32 &precision)
const unsigned C_INT32 &	getPrecision () const
virtual const std::string &	getKey () const

---

Constructor & Destructor Documentation

CReportDefinition::CReportDefinition	(	const std::string &	name = "NoName",
		const CCopasiContainer *	pParent = NULL
	)

Default constructor.

CReportDefinition class. This class describes the Report Definition

Created for Copasi by Mudita Singhal

CReportDefinition::CReportDefinition	(	const CReportDefinition &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor.

CReportDefinition::~CReportDefinition

(

)

Destructor.

---

Member Function Documentation

void CReportDefinition::cleanup

(

)

cleanup

std::vector< CRegisteredObjectName > * CReportDefinition::getBodyAddr

(

)

gets the body in the report tag

const std::string& CReportDefinition::getComment

(

)

const [inline]

Returns the comments in the report tag

std::vector< CRegisteredObjectName > * CReportDefinition::getFooterAddr

(

)

gets the footer in the report tag

std::vector< CRegisteredObjectName > * CReportDefinition::getHeaderAddr

(

)

gets the header in the report tag

const std::string & CReportDefinition::getKey

(

)

const [virtual]

Reimplemented from CCopasiObject.

const unsigned C_INT32 & CReportDefinition::getPrecision

(

)

const

Retrieve the precsion for floating point numbers;

Returns:

const unsigned C_INT32 & precision

const CCopasiReportSeparator & CReportDefinition::getSeparator

(

)

const

std::vector< CRegisteredObjectName > * CReportDefinition::getTableAddr

(

)

gets the footer in the report tag

const CCopasiTask::Type & CReportDefinition::getTaskType

(

)

const

bool CReportDefinition::getTitle

(

)

const

bool CReportDefinition::isTable

(

)

const

bool CReportDefinition::preCompileTable

(

const std::vector< CCopasiContainer * > &

listOfContainer = CCopasiContainer::EmptyList

)

Convert the table list into a header and body list.

Parameters:

const

std::vector< CCopasiContainer * > & listOfContainer (default: CCopasiContainer::EmptyList)

Returns:

bool success

void CReportDefinition::setComment

(

const std::string &

comment

)

[inline]

sets the comments in the report tag

void CReportDefinition::setIsTable

(

bool

table

)

void CReportDefinition::setPrecision

(

const unsigned C_INT32 &

precision

)

Set the precsion for floating point numbers;

Parameters:

const

unsigned C_INT32 & precision

void CReportDefinition::setSeparator

(

const CCopasiReportSeparator &

Separator

)

bool CReportDefinition::setTaskType

(

const CCopasiTask::Type &

taskType

)

void CReportDefinition::setTitle

(

bool

title

)

---

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

• copasi/report/CReportDefinition.h
• copasi/report/CReportDefinition.cpp