CTSSATask Class Reference

#include <CTSSATask.h>

Inheritance diagram for CTSSATask:

List of all members.

Public Member Functions
	CTSSATask (const CCopasiContainer *pParent=NULL)
	CTSSATask (const CTSSATask &src, const CCopasiContainer *pParent=NULL)
	~CTSSATask ()
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)
CState *	getState ()
const CTimeSeries &	getTimeSeries () const
Static Public Attributes
static const unsigned C_INT32	ValidMethods []

---

Constructor & Destructor Documentation

CTSSATask::CTSSATask

(

const CCopasiContainer *

pParent = NULL

)

Default constructor

Parameters:

const

CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

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

CTSSATask::~CTSSATask

(

)

Destructor

---

Member Function Documentation

CState * CTSSATask::getState

(

)

Retrieves a pointer to current state of the integration.

Returns:

CState * pState

const CTimeSeries & CTSSATask::getTimeSeries

(

)

const

gets a reference to the time series

Returns:

time series

bool CTSSATask::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.

bool CTSSATask::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 CTSSATask::processStart

(

const bool &

useInitialValues

)

Starts the process of integration by calling CTSSAMethod::start

Parameters:

const

bool & useInitialValues

bool CTSSATask::processStep

(

const C_FLOAT64 &

nextTime

)

Integrates one step

Parameters:

const

C_FLOAT64 & nextTime

Returns:

bool success;

bool CTSSATask::restore

(

)

[virtual]

Perform neccessary cleaup procedures

Reimplemented from CCopasiTask.

bool CTSSATask::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 CTSSATask::ValidMethods [static]

Initial value:

{
  CCopasiMethod::tssILDM,
  CCopasiMethod::tssILDMModified,


 
  CCopasiMethod::unset
}

The methods which can be selected for preforming this task.

Reimplemented from CCopasiTask.

---

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

• copasi/tssanalysis/CTSSATask.h
• copasi/tssanalysis/CTSSATask.cpp