copasi API  0.1
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
CCopasiProblem Class Reference

#include <CCopasiProblem.h>

Inheritance diagram for CCopasiProblem:
CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject CCrossSectionProblem CEFMProblem CLyapProblem CMCAProblem CMoietiesProblem COptProblem CScanProblem CSensProblem CSteadyStateProblem CTrajectoryProblem CTSSAProblem

List of all members.

Public Member Functions

 CCopasiProblem (const CCopasiProblem &src, const CCopasiContainer *pParent=NULL)
virtual ~CCopasiProblem ()
const CCopasiTask::TypegetType () const
virtual bool setModel (CModel *pModel)
CModelgetModel () const
virtual bool setCallBack (CProcessReport *pCallBack)
virtual bool initialize ()
virtual bool restore (const bool &updateModel)
virtual void print (std::ostream *ostream) const
virtual void printResult (std::ostream *ostream) const

Protected Member Functions

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

Protected Attributes

CModelmpModel
CProcessReportmpCallBack
CReportmpReport

Friends

std::ostream & operator<< (std::ostream &os, const CCopasiProblem &o)

Constructor & Destructor Documentation

CCopasiProblem::CCopasiProblem ( const CCopasiTask::Type type,
const CCopasiContainer pParent = NULL 
) [protected]

Specific constructor

Parameters:
constCCopasiTask::Type & type
constCCopasiContainer * pParent (default: NULL)
CCopasiProblem::CCopasiProblem ( const CCopasiProblem src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters:
constCCopasiProblemr & src
constCCopasiContainer * pParent (default: NULL)
CCopasiProblem::~CCopasiProblem ( ) [virtual]

Destructor


Member Function Documentation

CModel * CCopasiProblem::getModel ( ) const

Retrieve the model of the problem

Returns:
CModel * pModel
const CCopasiTask::Type & CCopasiProblem::getType ( void  ) const

Retrieve the type of the problem

Returns:
const string & type

Reimplemented from CCopasiParameter.

bool CCopasiProblem::initialize ( ) [virtual]

Sets the initial value (in case this applies to the specific problem) Do all neccessary initialization so that calls to caluclate will be successful. This is called once from CCopasiTask::process()

Returns:
bool succes

Reimplemented in COptProblem, CEFMProblem, CFitProblem, and CSteadyStateProblem.

void CCopasiProblem::print ( std::ostream *  ostream) const [virtual]

calculate function for optimization

Returns:
bool fullfilled calculate function for optimization
bool fullfilled 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.

Reimplemented in COptProblem, CSensProblem, CMCAProblem, CFitProblem, and CCrossSectionProblem.

void CCopasiProblem::printResult ( std::ostream *  ostream) const [virtual]

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

Parameters:
std::ostream* ostream

Reimplemented in COptProblem, CSensProblem, CLyapProblem, CFitProblem, CEFMProblem, CMCAProblem, and CMoietiesProblem.

bool CCopasiProblem::restore ( const bool &  updateModel) [virtual]

Do the calculatting based on CalculateVariables and fill CalculateResults with the results.

Returns:
bool succes Do all neccessary restore procedures so that the model is in the same state as before const bool & updateModel
bool succes

Reimplemented in COptProblem, and CFitProblem.

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

Set the call back of the problem

Parameters:
CProcessReport* pCallBack
Returns:
bool succes

Reimplemented in COptProblem, CEFMProblem, and CFitProblem.

bool CCopasiProblem::setModel ( CModel pModel) [virtual]

Set the model of the problem

Parameters:
CModel* pModel
Returns:
bool succes

Reimplemented in COptProblem, CFitProblem, and CMCAProblem.


Friends And Related Function Documentation

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

Output stream operator

Parameters:
ostream& os
constCCopasiProblem & A
Returns:
ostream & os

Member Data Documentation

a pointer to the callback

The model of the problem

A pointer to the report


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