CCopasiTimer Class Reference

#include <CCopasiTimer.h>

Inheritance diagram for CCopasiTimer:

List of all members.

Public Types
enum	Type { WALL = 0, CPU }
Public Member Functions
	CCopasiTimer (const Type &type=WALL, const CCopasiContainer *pParent=NULL)
	CCopasiTimer (const CCopasiTimer &src, const CCopasiContainer *pParent=NULL)
	~CCopasiTimer ()
bool	start ()
void	refresh ()
const CCopasiTimeVariable &	getElapsedTime ()
virtual void	print (std::ostream *ostream) const
virtual void *	getValuePointer () const

---

Member Enumeration Documentation

enum CCopasiTimer::Type

Enumeration of timer types

Enumerator:

WALL
CPU

---

Constructor & Destructor Documentation

CCopasiTimer::CCopasiTimer	(	const Type &	type = WALL,
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

const	Type & type (default: WALL)
const	CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

const	CCopasiTimer & src
const	CCopasiContainer * pParent (default: NULL)

CCopasiTimer::~CCopasiTimer

(

)

Destructor.

---

Member Function Documentation

const CCopasiTimeVariable & CCopasiTimer::getElapsedTime

(

)

Retrieve the elapsed time.

Returns:

const CCopasiTimeVariable & elapsedTime

void * CCopasiTimer::getValuePointer

(

)

const [virtual]

Reimplemented from CCopasiObject.

void CCopasiTimer::print

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any object. The default implementation provided with CCopasiObject uses the ostream operator<< of the object to print the object.To overide this default behaviour one needs to reimplement the virtual print function.

Parameters:

std::ostream

* ostream

Reimplemented from CCopasiObject.

void CCopasiTimer::refresh

(

)

Actualizes the timer.

bool CCopasiTimer::start

(

)

Start or restart the timer.

Returns:

bool success

---

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

• copasi/report/CCopasiTimer.h
• copasi/report/CCopasiTimer.cpp