CSensTask Class Reference

#include <CSensTask.h>

Inheritance diagram for CSensTask:

List of all members.

Public Member Functions
	CSensTask (const CCopasiContainer *pParent=NULL)
	CSensTask (const CSensTask &src, const CCopasiContainer *pParent=NULL)
virtual	~CSensTask ()
virtual bool	updateMatrices ()
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
virtual void	print (std::ostream *ostream) const
Friends
std::ostream &	operator<< (std::ostream &os, const CSensTask &A)

---

Detailed Description

CSensTask class.

---

Constructor & Destructor Documentation

CSensTask::CSensTask

(

const CCopasiContainer *

pParent = NULL

)

Default constructor

Parameters:

const

CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

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

CSensTask::~CSensTask

(

)

[virtual]

Destructor

---

Member Function Documentation

bool CSensTask::initialize	(	const OutputFlag &	of,
		COutputHandler *	pOutputHandler,
		std::ostream *	pOstream
	)		[virtual]

Initialize the task. If an ostream is given this ostream is used instead of the target specified in the report. This allows nested tasks to share the same output device.

Parameters:

const	OutputFlag & of
COutputHandler	* pOutputHandler
std::ostream	* pOstream (default: NULL)

Returns:

bool success

Reimplemented from CCopasiTask.

void CSensTask::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.

bool CSensTask::process

(

const bool &

useInitialValues

)

[virtual]

Process the task with or without initializing to the initial state.

Parameters:

const

bool & useInitialValues

Returns:

bool success

Reimplemented from CCopasiTask.

bool CSensTask::updateMatrices

(

)

[virtual]

Resizes result matrices and updates array annotations. This is used when we need to know about the data structures of a task result without actually performing the task, e.g. when selecting objects for output. For now we assume that this functionality is also performed when initialize() is called.

Reimplemented from CCopasiTask.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CSensTask &	A
	)		[friend]

---

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

• copasi/sensitivities/CSensTask.h
• copasi/sensitivities/CSensTask.cpp