CTrajectoryTask Class Reference

#include <CTrajectoryTask.h>

Inheritance diagram for CTrajectoryTask:

List of all members.

Public Member Functions
	CTrajectoryTask (const CCopasiContainer *pParent=NULL)
	CTrajectoryTask (const CTrajectoryTask &src, const CCopasiContainer *pParent=NULL)
	~CTrajectoryTask ()
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
void	processStart (const bool &useInitialValues)
bool	processStep (const C_FLOAT64 &nextTime)
virtual bool	restore ()
virtual bool	setMethodType (const int &type)
void	load (CReadConfig &configBuffer)
CState *	getState ()
const CTimeSeries &	getTimeSeries () const
Static Public Attributes
static const unsigned C_INT32	ValidMethods []

---

Constructor & Destructor Documentation

CTrajectoryTask::CTrajectoryTask

(

const CCopasiContainer *

pParent = NULL

)

Default constructor

Parameters:

const

CCopasiContainer * pParent (default: NULL)

CTrajectoryTask::CTrajectoryTask	(	const CTrajectoryTask &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor

Parameters:

const	CTrajectoryTask & src
const	CCopasiContainer * pParent (default: NULL)

CTrajectoryTask::~CTrajectoryTask

(

)

Destructor

---

Member Function Documentation

CState * CTrajectoryTask::getState

(

)

Retrieves a pointer to current state of the integration.

Returns:

CState * pState

const CTimeSeries & CTrajectoryTask::getTimeSeries

(

)

const

gets a reference to the time series

Returns:

time series

bool CTrajectoryTask::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:

const	OutputFlag & of
COutputHandler	* pOutputHandler
std::ostream	* pOstream (default: NULL)

Returns:

bool success

Reimplemented from CCopasiTask.

void CTrajectoryTask::load

(

CReadConfig &

configBuffer

)

Loads parameters for this solver with data coming from a CReadConfig object. (CReadConfig object reads an input stream)

Parameters:

configbuffer

reference to a CReadConfig object.

bool CTrajectoryTask::process

(

const bool &

useInitialValues

)

[virtual]

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

Parameters:

const

bool & useInitialValues

Returns:

bool success

Reimplemented from CCopasiTask.

void CTrajectoryTask::processStart

(

const bool &

useInitialValues

)

Starts the process of integration by calling CTrajectoryMethod::start

Parameters:

const

bool & useInitialValues

bool CTrajectoryTask::processStep

(

const C_FLOAT64 &

nextTime

)

Integrates one step

Parameters:

const

C_FLOAT64 & nextTime

Returns:

bool success;

bool CTrajectoryTask::restore

(

)

[virtual]

Perform necessary cleanup procedures

Reimplemented from CCopasiTask.

bool CTrajectoryTask::setMethodType

(

const int &

type

)

[virtual]

Set the method type applied to solve the task

Parameters:

const

CCopasiMethod::SubType & type

Returns:

bool success

Reimplemented from CCopasiTask.

---

Member Data Documentation

const unsigned C_INT32 CTrajectoryTask::ValidMethods [static]

Initial value:

{
  CCopasiMethod::deterministic,
  CCopasiMethod::stochastic,
  CCopasiMethod::directMethod,
  CCopasiMethod::tauLeap,
  CCopasiMethod::adaptiveSA,
  CCopasiMethod::hybrid,
  CCopasiMethod::hybridLSODA,


 
  CCopasiMethod::unset
}

The methods which can be selected for performing this task.

Reimplemented from CCopasiTask.

---

The documentation for this class was generated from the following files:

• copasi/trajectory/CTrajectoryTask.h
• copasi/trajectory/CTrajectoryTask.cpp