copasi API  0.1
Public Member Functions
CTrajectoryProblem Class Reference

#include <CTrajectoryProblem.h>

Inheritance diagram for CTrajectoryProblem:
CCopasiProblem CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject

List of all members.

Public Member Functions

 CTrajectoryProblem (const CCopasiContainer *pParent=NULL)
 CTrajectoryProblem (const CTrajectoryProblem &src, const CCopasiContainer *pParent=NULL)
 ~CTrajectoryProblem ()
virtual bool elevateChildren ()
void setStepNumber (const unsigned C_INT32 &stepNumber)
const unsigned C_INT32 & getStepNumber () const
void setStepSize (const C_FLOAT64 &stepSize)
const C_FLOAT64 & getStepSize () const
void setDuration (const C_FLOAT64 &duration)
const C_FLOAT64 & getDuration () const
void setOutputStartTime (const C_FLOAT64 &endTime)
const C_FLOAT64 & getOutputStartTime () const
void setTimeSeriesRequested (bool flag)
bool timeSeriesRequested () const
void load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)

Detailed Description

CTrajectoryProblem class. This class describes the trajectory problem, i.e., it allows to specify for example initial conditions and number of steps.

Created for Copasi by Stefan Hoops 2002


Constructor & Destructor Documentation

CTrajectoryProblem::CTrajectoryProblem ( const CCopasiContainer pParent = NULL)

The initial state, i.e., the starting conditions of the trajectroy. The final state of the trajectory at time EndTime Default constructor.

Parameters:
constCCopasiContainer * pParent (default: NULL)

CTrajectoryProblem class. This class describes the trajectory problem, i.e., it allows to specify for example initial conditions and number of steps.

Created for COPASI by Stefan Hoops 2002 Default constructor.

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

Copy constructor.

Parameters:
constCTrajectoryProblem & src CCopasiContainer * pParent (default: NULL)

Copy constructor.

Parameters:
const CTrajectoryProblem &src
CTrajectoryProblem::~CTrajectoryProblem ( )

Destructor.


Member Function Documentation

bool CTrajectoryProblem::elevateChildren ( ) [virtual]

This methods must be called to elevate subgroups to derived objects. The default implementation does nothing.

Returns:
bool success

Reimplemented from CCopasiParameterGroup.

const C_FLOAT64 & CTrajectoryProblem::getDuration ( ) const

Retrieve the end time.

Returns:
"const C_FLOAT64 &" duration
const C_FLOAT64 & CTrajectoryProblem::getOutputStartTime ( ) const

Retrieve the end time.

Returns:
"const C_FLOAT64 &" endTime
const unsigned C_INT32 & CTrajectoryProblem::getStepNumber ( ) const

Retrieve the number of time steps the trajectory method should integrate.

Returns:
"const unsigned C_INT32 &" stepNumber
const C_FLOAT64 & CTrajectoryProblem::getStepSize ( ) const

Retrieve the size a integration step the trajectory method should do.

Returns:
"const C_FLOAT64 &" stepSize
void CTrajectoryProblem::load ( CReadConfig configBuffer,
CReadConfig::Mode  mode = CReadConfig::NEXT 
)

Load a trajectory problem

Parameters:
CReadConfig &configBuffer
"CReadConfig::Modemode (Default: CReadConfig::NEXT)
void CTrajectoryProblem::setDuration ( const C_FLOAT64 &  duration)

Set the end time.

Parameters:
const C_FLOAT64 &duration bool success
void CTrajectoryProblem::setOutputStartTime ( const C_FLOAT64 &  endTime)

Set the end time.

Parameters:
const C_FLOAT64 &endTime
void CTrajectoryProblem::setStepNumber ( const unsigned C_INT32 &  stepNumber)

Set the number of time steps the trajectory method should integrate.

Parameters:
const unsigned C_INT32 &stepNumber bool success

Set the number of time steps the trajectory method should integrate.

Parameters:
const unsigned C_INT32 &stepNumber
void CTrajectoryProblem::setStepSize ( const C_FLOAT64 &  stepSize)

Set the size a integration step the trajectory method should do.

Parameters:
const C_FLOAT64 &stepSize bool success

Set the size a integration step the trajectory method should do.

Parameters:
const C_FLOAT64 &stepSize
void CTrajectoryProblem::setTimeSeriesRequested ( bool  flag)
bool CTrajectoryProblem::timeSeriesRequested ( ) const

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