CProcessReport Class Reference

#include <CProcessReport.h>

Inheritance diagram for CProcessReport:

List of all members.

Public Member Functions
	CProcessReport ()
virtual	~CProcessReport ()
virtual unsigned C_INT32	addItem (const std::string &name, const CCopasiParameter::Type &type, const void *pValue, const void *pEndValue=NULL)
virtual bool	progress ()
virtual bool	progressItem (const unsigned C_INT32 &handle)
virtual bool	proceed ()
virtual bool	reset ()
virtual bool	resetItem (const unsigned C_INT32 &handle)
virtual bool	finishItem (const unsigned C_INT32 &handle)
virtual bool	isValidHandle (const unsigned C_INT32 handle) const
virtual bool	setName (const std::string &name)
Protected Member Functions
virtual bool	finish ()
Protected Attributes
CVector< CProcessReportItem * >	mProcessReportItemList
std::string	mName

---

Constructor & Destructor Documentation

CProcessReport::CProcessReport

(

)

Default Constructor

CProcessReport::~CProcessReport

(

)

[virtual]

Destructor

---

Member Function Documentation

unsigned C_INT32 CProcessReport::addItem	(	const std::string &	name,
		const CCopasiParameter::Type &	type,
		const void *	pValue,
		const void *	pEndValue = NULL
	)		[virtual]

Add a process report item to to the list of reporting items. The return value is the handle of the item and can be used to indicate process, finish, or reset the item. If the method fails C_INVALID_INDEX is returned.

Parameters:

const	std::string & name
const	CCopasiParameter::Type & type
const	void * pValue
const	void * pEndValue = NULL

Returns:

unsigned C_INT32 handle

Reimplemented in CProgressBar.

bool CProcessReport::finish

(

)

[protected, virtual]

Indicate that all items are finished reporting. All item handles loose their validity. If the return value is false the calling process must halt execution and return.

Parameters:

bool

continue

Reimplemented in CProgressBar.

bool CProcessReport::finishItem

(

const unsigned C_INT32 &

handle

)

[virtual]

Indicate that item handle is finished reporting. The handle of that item is no longer valid after the call. If the return value is false the calling process must halt execution and return.

Parameters:

const	unsigned C_INT32 & handle
bool	continue

Reimplemented in CProgressBar.

bool CProcessReport::isValidHandle

(

const unsigned C_INT32

handle

)

const [virtual]

Check whether the handle is valid, i.e., usable in progress, reset and finish.

bool CProcessReport::proceed

(

)

[virtual]

Check whether processing shall proceed. If the return value is false the calling process must halt execution and return. This method is provided so that lengthy processing without advances in any of the reporting items can check whether continuation is requested.

Parameters:

bool

continue

Reimplemented in CProgressBar.

bool CProcessReport::progress

(

)

[virtual]

Report process on all items. If the return value is false the calling process must halt execution and return.

Parameters:

bool

continue

bool CProcessReport::progressItem

(

const unsigned C_INT32 &

handle

)

[virtual]

Report process on item handle. If the return value is false the calling process must halt execution and return.

Parameters:

const	unsigned C_INT32 & handle
bool	continue

Reimplemented in CProgressBar.

bool CProcessReport::reset

(

)

[virtual]

Reset all item handle. This means that the values of the items have changed but not as part of a continuous process. If you run multiple processes call reset between them. If the return value is false the calling process must halt execution and return.

Parameters:

bool

continue

bool CProcessReport::resetItem

(

const unsigned C_INT32 &

handle

)

[virtual]

Reset item handle. This means that the value of the item has changed but not as part of a continuous process. If you run multiple processes call reset between them. If the return value is false the calling process must halt execution and return.

Parameters:

const	unsigned C_INT32 & handle
bool	continue

Reimplemented in CProgressBar.

bool CProcessReport::setName

(

const std::string &

name

)

[virtual]

Set the name of the process.

Parameters:

const

std::string & name

Returns:

success

Reimplemented in CProgressBar.

---

Member Data Documentation

std::string CProcessReport::mName [protected]

The name of the process.

CVector< CProcessReportItem * > CProcessReport::mProcessReportItemList [protected]

The list process report items.

---

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

• copasi/utilities/CProcessReport.h
• copasi/utilities/CProcessReport.cpp