CTimeSeries Class Reference

#include <CTimeSeries.h>

Inheritance diagram for CTimeSeries:

List of all members.

Public Member Functions
	CTimeSeries ()
	CTimeSeries (const CTimeSeries &src)
	~CTimeSeries ()
virtual bool	compile (std::vector< CCopasiContainer * > listOfContainer, const CCopasiDataModel *pDataModel)
virtual void	output (const Activity &activity)
virtual void	separate (const Activity &activity)
virtual void	finish ()
void	allocate (const unsigned C_INT32 &steps)
void	clear ()
int	save (const std::string &fileName, bool writeConcentrations=false, const std::string &separator="\t") const
const unsigned C_INT32 &	getRecordedSteps () const
const unsigned C_INT32 &	getNumVariables () const
const C_FLOAT64 &	getData (const unsigned C_INT32 &step, const unsigned C_INT32 &variable) const
C_FLOAT64	getConcentrationData (const unsigned C_INT32 &step, const unsigned C_INT32 &variable) const
const std::string &	getTitle (const unsigned C_INT32 &variable) const
const std::string &	getKey (const unsigned C_INT32 &variable) const
std::string	getSBMLId (const unsigned C_INT32 &variable, const CCopasiDataModel *pDataModel) const

---

Constructor & Destructor Documentation

CTimeSeries::CTimeSeries

(

)

Default constructor

CTimeSeries::CTimeSeries

(

const CTimeSeries &

src

)

Copy constructor

Parameters:

const

CTimeSeries & src

CTimeSeries::~CTimeSeries

(

)

Destructor

---

Member Function Documentation

void CTimeSeries::allocate

(

const unsigned C_INT32 &

steps

)

The maximal number of recorded steps. This must be set before compiling

Parameters:

const

unsigned C_INT32 & steps

void CTimeSeries::clear

(

)

Clear the time series

bool CTimeSeries::compile	(	std::vector< CCopasiContainer * >	listOfContainer,
		const CCopasiDataModel *	pDataModel
	)		[virtual]

compile the object list from name vector

Parameters:

std::vector<	CCopasiContainer * > listOfContainer
const	CCopasiDataModel* pDataModel

Returns:

bool success

Reimplemented from COutputInterface.

void CTimeSeries::finish

(

)

[virtual]

Finish the output

Reimplemented from COutputInterface.

C_FLOAT64 CTimeSeries::getConcentrationData	(	const unsigned C_INT32 &	step,
		const unsigned C_INT32 &	variable
	)		const

Retrieve the data (concentration for species) for the indexed step and variable

Parameters:

const	unsigned C_INT32 & step
const	unsigned C_INT32 & variable

Returns:

const C_FLOAT64 & data

const C_FLOAT64 & CTimeSeries::getData	(	const unsigned C_INT32 &	step,
		const unsigned C_INT32 &	variable
	)		const

Retrieve the data (particle number for species) for the indexed step and variable

Parameters:

const	unsigned C_INT32 & step
const	unsigned C_INT32 & variable

Returns:

const C_FLOAT64 & data

const std::string & CTimeSeries::getKey

(

const unsigned C_INT32 &

variable

)

const

Retrieve the key of the model entity of the indexed variable (column)

Parameters:

const

unsigned C_INT32 & variable

Returns:

const std::string & key

const unsigned C_INT32 & CTimeSeries::getNumVariables

(

)

const

Retrieve the number of variables (columns)

Returns:

unsigned C_INT32 & numVariables

const unsigned C_INT32 & CTimeSeries::getRecordedSteps

(

)

const

Retrieve the number of time steps (rows)

Returns:

const unsigned C_INT32 & recordedSteps

std::string CTimeSeries::getSBMLId	(	const unsigned C_INT32 &	variable,
		const CCopasiDataModel *	pDataModel
	)		const

get the id of the SBML object corresponding to column indexed by variable. If there is no corresponding SBML object (e.g. if the model comes from a COPASI file) the empty string is returned.

Parameters:

const

unsigned C_INT32 & variable

Returns:

const std::string SBMLId

const std::string & CTimeSeries::getTitle

(

const unsigned C_INT32 &

variable

)

const

Retrieve the title of the indexed variable (column)

Parameters:

const

unsigned C_INT32 & variable

Returns:

const std::string & title

void CTimeSeries::output

(

const Activity &

activity

)

[virtual]

Perform an output event for the current activity

Parameters:

const

Activity & activity

Reimplemented from COutputInterface.

int CTimeSeries::save	(	const std::string &	fileName,
		bool	writeConcentrations = false,
		const std::string &	separator = "\t"
	)		const

Save the time series to a file

Parameters:

const	std::string & fileName
bool	writeConcentrations (default: false)
const	std::string& separator (default: "\t")

Returns:

int retcode

void CTimeSeries::separate

(

const Activity &

activity

)

[virtual]

Introduce an additional separator into the output

Parameters:

const

Activity & activity

Reimplemented from COutputInterface.

---

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

• copasi/trajectory/CTimeSeries.h
• copasi/trajectory/CTimeSeries.cpp