CLyapTask Class Reference

#include <CLyapTask.h>

Inheritance diagram for CLyapTask:

List of all members.

Public Member Functions
	CLyapTask (const CCopasiContainer *pParent=NULL)
	~CLyapTask ()
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
virtual bool	restore ()
const CVector< C_FLOAT64 > &	exponents () const
const C_FLOAT64 &	sumOfExponents () const
const C_FLOAT64 &	averageDivergence () const
bool	resultAvailable () const
bool	resultHasDivergence () const
unsigned C_INT32	modelVariablesInResult () const
unsigned C_INT32	numberOfExponentsCalculated () const
virtual bool	setMethodType (const int &type)
bool	methodCallback (const C_FLOAT64 &percentage, bool onlyProgress)
void	printResult (std::ostream *ostream) const
Friends
class	CLyapWolfMethod

---

Constructor & Destructor Documentation

CLyapTask::CLyapTask

(

const CCopasiContainer *

pParent = NULL

)

Default constructor

Parameters:

const

CCopasiContainer * pParent (default: NULL)

CLyapTask::~CLyapTask

(

)

Destructor

---

Member Function Documentation

const C_FLOAT64& CLyapTask::averageDivergence

(

)

const [inline]

const CVector<C_FLOAT64>& CLyapTask::exponents

(

)

const [inline]

bool CLyapTask::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 CLyapTask::methodCallback	(	const C_FLOAT64 &	percentage,
		bool	onlyProgress
	)

This is called by the method to generate the output and update the progress bar. The parameter is the percentage for the progress bar. The return value is the return value of the progress bar handler (and determines if the calculation will be stopped). If onlyProgess is true, no output is done.

unsigned C_INT32 CLyapTask::modelVariablesInResult

(

)

const

how many independent variables had the model at the time of the last calculation?

unsigned C_INT32 CLyapTask::numberOfExponentsCalculated

(

)

const

void CLyapTask::printResult

(

std::ostream *

ostream

)

const

This functionality is expected from CLyapProblem but has to be implmented here for the moment. This is called from the corresponding method of the problem

bool CLyapTask::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 CLyapTask::restore

(

)

[virtual]

Perform neccessary cleaup procedures

Reimplemented from CCopasiTask.

bool CLyapTask::resultAvailable

(

)

const

bool CLyapTask::resultHasDivergence

(

)

const

was divergence requested for the last calculation?

bool CLyapTask::setMethodType

(

const int &

type

)

[virtual]

Set the method type applied to solve the task

Parameters:

const

CCopasiMethod::SubType & type

Returns:

bool success

Reimplemented from CCopasiTask.

const C_FLOAT64& CLyapTask::sumOfExponents

(

)

const [inline]

---

Friends And Related Function Documentation

friend class CLyapWolfMethod [friend]

---

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

• copasi/lyap/CLyapTask.h
• copasi/lyap/CLyapTask.cpp