COptTask Class Reference

#include <COptTask.h>

Inheritance diagram for COptTask:

List of all members.

Public Member Functions
	COptTask (const CCopasiTask::Type &type=CCopasiTask::optimization, const CCopasiContainer *pParent=NULL)
	COptTask (const COptTask &src, const CCopasiContainer *pParent=NULL)
	~COptTask ()
void	cleanup ()
virtual bool	setCallBack (CProcessReport *pCallBack)
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
virtual bool	setMethodType (const int &type)
Static Public Attributes
static unsigned C_INT32	ValidMethods []

---

Constructor & Destructor Documentation

COptTask::COptTask	(	const CCopasiTask::Type &	type = CCopasiTask::optimization,
		const CCopasiContainer *	pParent = NULL
	)

default constructor

Parameters:

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

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

Copy constructor

Parameters:

const

COptTask & src

COptTask::~COptTask

(

)

Destructor

---

Member Function Documentation

void COptTask::cleanup

(

)

cleanup()

Reimplemented from CCopasiTask.

Reimplemented in CFitTask.

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

Reimplemented in CFitTask.

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

Reimplemented in CFitTask.

bool COptTask::setCallBack

(

CProcessReport *

pCallBack

)

[virtual]

Set the call back of the task

Parameters:

CProcessReport

* pCallBack

Returns:

bool succes

Reimplemented from CCopasiTask.

Reimplemented in CFitTask.

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

Reimplemented in CFitTask.

---

Member Data Documentation

unsigned C_INT32 COptTask::ValidMethods [static]

Initial value:

  {
    CCopasiMethod::Statistics,
    CCopasiMethod::GeneticAlgorithm,
    CCopasiMethod::GeneticAlgorithmSR,
    CCopasiMethod::HookeJeeves,
    CCopasiMethod::LevenbergMarquardt,
    CCopasiMethod::EvolutionaryProgram,
    CCopasiMethod::RandomSearch,
    CCopasiMethod::NelderMead,
    CCopasiMethod::ParticleSwarm,
    CCopasiMethod::Praxis,
    CCopasiMethod::TruncatedNewton,
    CCopasiMethod::SimulatedAnnealing,
    CCopasiMethod::SRES,
    CCopasiMethod::SteepestDescent,
    CCopasiMethod::unset
  }

The methods which can be selected for preforming this task.

COptTask class.

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

Reimplemented from CCopasiTask.

---

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

• copasi/optimization/COptTask.h
• copasi/optimization/COptTask.cpp