copasi API  0.1
Public Member Functions
CFitTask Class Reference

#include <CFitTask.h>

Inheritance diagram for CFitTask:
COptTask CCopasiTask CCopasiContainer CCopasiObject

List of all members.

Public Member Functions

 CFitTask (const CCopasiTask::Type &type=CCopasiTask::parameterFitting, const CCopasiContainer *pParent=NULL)
 CFitTask (const CFitTask &src, const CCopasiContainer *pParent=NULL)
 ~CFitTask ()
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 restore ()
virtual bool setMethodType (const int &type)

Detailed Description

CFitTask class.

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


Constructor & Destructor Documentation

CFitTask::CFitTask ( const CCopasiTask::Type type = CCopasiTask::parameterFitting,
const CCopasiContainer pParent = NULL 
)

default constructor

Parameters:
constCCopasiTask::Type & type (default: parameterFitting)
constCCopasiContainer * pParent (default: NULL)

CFitTask class.

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

CFitTask::CFitTask ( const CFitTask src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters:
constCFitTask & src
constCCopasiContainer * pParent (default: NULL)
CFitTask::~CFitTask ( )

Destructor


Member Function Documentation

void CFitTask::cleanup ( )

cleanup()

Reimplemented from COptTask.

bool CFitTask::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:
constOutputFlag & of
COutputHandler* pOutputHandler
std::ostream* pOstream (default: NULL)
Returns:
bool success

Reimplemented from COptTask.

bool CFitTask::process ( const bool &  useInitialValues) [virtual]

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

Parameters:
constbool & useInitialValues
Returns:
bool success

Reimplemented from COptTask.

bool CFitTask::restore ( ) [virtual]

Perform neccessary cleaup procedures

Reimplemented from CCopasiTask.

bool CFitTask::setCallBack ( CProcessReport pCallBack) [virtual]

Set the call back of the task

Parameters:
CProcessReport* pCallBack
Returns:
bool succes

Reimplemented from COptTask.

bool CFitTask::setMethodType ( const int &  type) [virtual]

Set the method type applied to solve the task

Parameters:
constCCopasiMethod::SubType & type
Returns:
bool success

Reimplemented from COptTask.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines