copasi API  0.1
Public Member Functions | Friends
CMCAProblem Class Reference

#include <CMCAProblem.h>

Inheritance diagram for CMCAProblem:
CCopasiProblem CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject

List of all members.

Public Member Functions

 CMCAProblem (const CCopasiContainer *pParent=NULL)
 CMCAProblem (const CMCAProblem &src, const CCopasiContainer *pParent=NULL)
virtual ~CMCAProblem ()
virtual bool setModel (CModel *pModel)
void setInitialState (const CState &initialState)
void setSteadyStateRequested (const bool &steadyStateRequested)
bool isSteadyStateRequested () const
CSteadyStateTaskgetSubTask () const
void load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)
virtual void printResult (std::ostream *ostream) const
virtual void print (std::ostream *ostream) const

Friends

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

Constructor & Destructor Documentation

CMCAProblem::CMCAProblem ( const CCopasiContainer pParent = NULL)

Default constructor.

Parameters:
constCCopasiContainer * pParent (default: NULL)

CMCAProblem class. This class describes the metabolic control analysis problem, i.e., it allows to specify for example initial conditions.

Created for Copasi by Ralph Gauges 2004 Default constructor.

Parameters:
CModel *pModel
CMCAProblem::CMCAProblem ( const CMCAProblem src,
const CCopasiContainer pParent = NULL 
)

Copy constructor.

Parameters:
const CMCAProblem &src CCopasiContainer * pParent (default: NULL)

Copy constructor.

Parameters:
const CMCAProblem &src
CMCAProblem::~CMCAProblem ( ) [virtual]

Destructor.


Member Function Documentation

CSteadyStateTask * CMCAProblem::getSubTask ( ) const

Retrieve the subtask return CSteadyStateTask * pSubTask;

bool CMCAProblem::isSteadyStateRequested ( ) const

Retrieve whether a steady state analysis is requested.

Returns:
bool steadyStateRequested

Retrieve whether the steady state analysis is requested.

Returns:
bool steadyStateRequested
void CMCAProblem::load ( CReadConfig configBuffer,
CReadConfig::Mode  mode = CReadConfig::NEXT 
)

Load a trajectory problem

Parameters:
CReadConfig &configBuffer
"CReadConfig::Modemode (Default: CReadConfig::NEXT)
void CMCAProblem::print ( std::ostream *  ostream) const [virtual]

This is the output method for any object. It calls the insert operator<<

Parameters:
std::ostream* ostream

Reimplemented from CCopasiProblem.

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

This is the output method for any result of a problem. The default implementation is 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 from CCopasiProblem.

void CMCAProblem::setInitialState ( const CState initialState)

Set the initial state of the problem.

Parameters:
constCState & InitialState

Set the initial state of the problem.

Parameters:
constCState & initialState
bool CMCAProblem::setModel ( CModel pModel) [virtual]

Set the model of the problem

Parameters:
CModel* pModel
Returns:
bool succes

Set the model the problem is dealing with.

Parameters:
CModel *pModel

Reimplemented from CCopasiProblem.

void CMCAProblem::setSteadyStateRequested ( const bool &  steadyStateRequested)

Retrieve the initial state of the problem.

Returns:
"const CState &" pInitialState Set whether the steady state analysis is requested.
Parameters:
constbool & steadyStateRequested

Set whether the steady state analysis is requested.

Parameters:
bool* steadyStateRequested

Friends And Related Function Documentation

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

Output stream operator. Prints description of the problem incl. the subtask

Parameters:
ostream& os
constCMCAProblem & A
Returns:
ostream & os

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