copasi API  0.1
Public Member Functions
CTSSAProblem Class Reference

#include <CTSSAProblem.h>

Inheritance diagram for CTSSAProblem:
CCopasiProblem CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject

List of all members.

Public Member Functions

 CTSSAProblem (const CCopasiContainer *pParent=NULL)
 CTSSAProblem (const CTSSAProblem &src, const CCopasiContainer *pParent=NULL)
 ~CTSSAProblem ()
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

Detailed Description

CTSSAProblem class. This class describes the time scale separation analysis problem, i.e., it allows to specify for example initial conditions and number of steps.


Constructor & Destructor Documentation

CTSSAProblem::CTSSAProblem ( const CCopasiContainer pParent = NULL)

Default constructor.

Parameters:
constCCopasiContainer * pParent (default: NULL)

CTSSAProblem class. This class describes the time scale separation analysis problem, i.e., it allows to specify for example initial conditions and number of steps. Default constructor.

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

Copy constructor.

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

Copy constructor.

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

Destructor.


Member Function Documentation

bool CTSSAProblem::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 & CTSSAProblem::getDuration ( ) const

Retrieve the end time.

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

Retrieve the end time.

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

Retrieve the number of time steps the method should integrate.

Returns:
"const unsigned C_INT32 &" stepNumber

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

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

Retrieve the size a integration step the method should do.

Returns:
"const C_FLOAT64 &" stepSize

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

Returns:
"const C_FLOAT64 &" stepSize
void CTSSAProblem::setDuration ( const C_FLOAT64 &  duration)

Set the end time.

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

Set the end time.

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

Set the number of time steps the 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 CTSSAProblem::setStepSize ( const C_FLOAT64 &  stepSize)

Set the size a integration step the 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 CTSSAProblem::setTimeSeriesRequested ( bool  flag)
bool CTSSAProblem::timeSeriesRequested ( ) const

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