CCopasiMethod Class Reference

#include <CCopasiMethod.h>

Inheritance diagram for CCopasiMethod:

List of all members.

Public Types
enum	SubType {   unset = 0, RandomSearch, RandomSearchMaster, SimulatedAnnealing,   GeneticAlgorithm, EvolutionaryProgram, SteepestDescent, HybridGASA,   GeneticAlgorithmSR, HookeJeeves, LevenbergMarquardt, NelderMead,   SRES, Statistics, ParticleSwarm, Praxis,   TruncatedNewton, Newton, deterministic, LSODAR,   directMethod, stochastic, tauLeap, adaptiveSA,   hybrid, hybridLSODA, DsaLsodar, tssILDM,   tssILDMModified, tssCSP, mcaMethodReder, scanMethod,   lyapWolf, sensMethod, EFMAlgorithm, EFMBitPatternTreeAlgorithm,   EFMBitPatternAlgorithm, Householder, crossSectionMethod }
Public Member Functions
	CCopasiMethod (const CCopasiMethod &src, const CCopasiContainer *pParent=NULL)
virtual	~CCopasiMethod ()
virtual bool	setCallBack (CProcessReport *pCallBack)
const CCopasiTask::Type &	getType () const
const CCopasiMethod::SubType &	getSubType () const
virtual bool	isValidProblem (const CCopasiProblem *pProblem)
virtual void	load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::SEARCH)
virtual void	print (std::ostream *ostream) const
virtual void	printResult (std::ostream *ostream) const
Static Public Attributes
static const char *	SubTypeName []
static const char *	XMLSubType []
Protected Member Functions
	CCopasiMethod (const CCopasiTask::Type &taskType, const SubType &subType, const CCopasiContainer *pParent=NULL)
Protected Attributes
CProcessReport *	mpCallBack
Friends
std::ostream &	operator<< (std::ostream &os, const CCopasiMethod &o)

---

Member Enumeration Documentation

enum CCopasiMethod::SubType

Enumeration of the sub types of methods known to COPASI.

Enumerator:

unset
RandomSearch
RandomSearchMaster
SimulatedAnnealing
GeneticAlgorithm
EvolutionaryProgram
SteepestDescent
HybridGASA
GeneticAlgorithmSR
HookeJeeves
LevenbergMarquardt
NelderMead
SRES
Statistics
ParticleSwarm
Praxis
TruncatedNewton
Newton
deterministic
LSODAR
directMethod
stochastic
tauLeap
adaptiveSA
hybrid
hybridLSODA
DsaLsodar
tssILDM
tssILDMModified
tssCSP
mcaMethodReder
scanMethod
lyapWolf
sensMethod
EFMAlgorithm
EFMBitPatternTreeAlgorithm
EFMBitPatternAlgorithm
Householder
crossSectionMethod

---

Constructor & Destructor Documentation

CCopasiMethod::CCopasiMethod	(	const CCopasiTask::Type &	taskType,
		const SubType &	subType,
		const CCopasiContainer *	pParent = NULL
	)		[protected]

Specific constructor

Parameters:

const	CCopasiTask::Type & type
const	CCopasiMethod::SubType & subType
const	CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

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

CCopasiMethod::~CCopasiMethod

(

)

[virtual]

Destructor

---

Member Function Documentation

const CCopasiMethod::SubType & CCopasiMethod::getSubType

(

)

const

Retrieve the sub type of the method

Returns:

CCopasiMethod::SubType & subType

const CCopasiTask::Type & CCopasiMethod::getType

(

void

)

const

Retrieve the type of the method

Returns:

const string & type

Reimplemented from CCopasiParameter.

bool CCopasiMethod::isValidProblem

(

const CCopasiProblem *

pProblem

)

[virtual]

Check if the method is suitable for this problem

Returns:

bool suitability of the method

Reimplemented in CTrajectoryMethodDsaLsodar, CScanMethod, CStochMethod, CMCAMethod, CLyapWolfMethod, CTrajAdaptiveSA, CHybridMethodLSODA, CStochDirectMethod, CHybridMethod, CTauLeapMethod, CTrajectoryMethod, CSteadyStateMethod, CTSSAMethod, CLyapMethod, COptMethod, CNewtonMethod, CSensMethod, CEFMMethod, CFitMethod, and CCrossSectionMethod.

void CCopasiMethod::load	(	CReadConfig &	configBuffer,
		CReadConfig::Mode	mode = CReadConfig::SEARCH
	)		[virtual]

Load a list of parameters

Parameters:

CReadConfig &	configBuffer
CReadConfig::Mode	mode Default(CReadConfig::SEARCH)

Reimplemented in CNewtonMethod.

void CCopasiMethod::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 CCopasiParameterGroup.

void CCopasiMethod::printResult

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any result of a method. The default implementation provided with CCopasiMethod. Does only print "Not implmented." To overide this default behaviour one needs to reimplement the virtual printResult function.

Parameters:

std::ostream

* ostream

Reimplemented in CCSPMethod, CILDMMethod, and CILDMModifiedMethod.

bool CCopasiMethod::setCallBack

(

CProcessReport *

pCallBack

)

[virtual]

Set the call back of the problem

Parameters:

CProcessReport

* pCallBack

Returns:

bool succes

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CCopasiMethod &	o
	)		[friend]

Output stream operator

Parameters:

ostream	& os
const	CCopasiMethod & A

Returns:

ostream & os

---

Member Data Documentation

CProcessReport* CCopasiMethod::mpCallBack [protected]

a pointer to the callback

const char * CCopasiMethod::SubTypeName [static]

String literals for the GUI to display sub type names of methods known to COPASI.

CCopasiMethod class. This class is used to describe a task in COPASI. This class is intended to be used as the parent class for all methods whithin COPASI.

Created for Copasi by Stefan Hoops 2003

const char * CCopasiMethod::XMLSubType [static]

XML sub type names of methods known to COPASI.

---

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

• copasi/utilities/CCopasiMethod.h
• copasi/utilities/CCopasiMethod.cpp