CScanTask Class Reference

#include <CScanTask.h>

Inheritance diagram for CScanTask:

List of all members.

Public Member Functions
	CScanTask (const CCopasiContainer *pParent=NULL)
	CScanTask (const CScanTask &src, const CCopasiContainer *pParent=NULL)
	~CScanTask ()
void	cleanup ()
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
void	load (CReadConfig &configBuffer)
bool	processCallback ()
bool	outputSeparatorCallback (bool isLast=false)
Protected Member Functions
bool	initSubtask (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)

---

Constructor & Destructor Documentation

CScanTask::CScanTask

(

const CCopasiContainer *

pParent = NULL

)

default constructor

CScanTask class.

This class implements a scan task which is comprised of a of a problem and a method.

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

Copy constructor

Parameters:

const

CScanTask & src

CScanTask::~CScanTask

(

)

Destructor

---

Member Function Documentation

void CScanTask::cleanup

(

)

cleanup()

Reimplemented from CCopasiTask.

bool CScanTask::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.

bool CScanTask::initSubtask	(	const OutputFlag &	of,
		COutputHandler *	pOutputHandler,
		std::ostream *	pOstream
	)		[protected]

Init the subtask

Parameters:

const	OutputFlag & of
COutputHandler	* pOutputHandler

Returns:

success

void CScanTask::load

(

CReadConfig &

configBuffer

)

Loads parameters for this solver with data coming from a CReadConfig object. (CReadConfig object reads an input stream)

Parameters:

configbuffer

reference to a CReadConfig object.

bool CScanTask::outputSeparatorCallback

(

bool

isLast = false

)

output separators if isLast==true this method has to decide if a separator should be generated dependent on mOutputInSubtask.

bool CScanTask::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 CScanTask::processCallback

(

)

Do the subtask and the output

---

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

• copasi/scan/CScanTask.h
• copasi/scan/CScanTask.cpp