CExperimentSet Class Reference

#include <CExperimentSet.h>

Inheritance diagram for CExperimentSet:

List of all members.

Public Member Functions
	CExperimentSet (const CCopasiContainer *pParent, const std::string &name="Experiment Set")
	CExperimentSet (const CExperimentSet &src, const CCopasiContainer *pParent=NULL)
	CExperimentSet (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
virtual	~CExperimentSet ()
virtual bool	elevateChildren ()
bool	compile (const std::vector< CCopasiContainer * > listOfContainer=CCopasiContainer::EmptyList)
bool	calculateStatistics ()
unsigned C_INT32	getExperimentCount () const
CExperiment *	addExperiment (const CExperiment &experiment)
void	removeExperiment (const unsigned C_INT32 &index)
CExperiment *	getExperiment (const unsigned C_INT32 &index)
const CExperiment *	getExperiment (const unsigned C_INT32 &index) const
CExperiment *	getExperiment (const std::string &name)
const CExperiment *	getExperiment (const std::string &name) const
bool	hasDataForTaskType (const CCopasiTask::Type &type) const
const CCopasiTask::Type &	getExperimentType (const unsigned C_INT32 &index) const
const CMatrix< C_FLOAT64 > &	getIndependentData (const unsigned C_INT32 &index) const
const CMatrix< C_FLOAT64 > &	getDependentData (const unsigned C_INT32 &index) const
unsigned C_INT32	keyToIndex (const std::string &key) const
void	sort ()
std::vector< std::string >	getFileNames () const
unsigned C_INT32	getDataPointCount () const
const CVector< CCopasiObject * > &	getDependentObjects () const
const CVector< C_FLOAT64 > &	getDependentObjectiveValues () const
const CVector< C_FLOAT64 > &	getDependentRMS () const
const CVector< C_FLOAT64 > &	getDependentErrorMean () const
const CVector< C_FLOAT64 > &	getDependentErrorMeanSD () const

---

Constructor & Destructor Documentation

CExperimentSet::CExperimentSet	(	const CCopasiContainer *	pParent,
		const std::string &	name = "Experiment Set"
	)

Default constructor

Parameters:

const	CCopasiContainer * pParent
const	std::string & name (default: Experiment Set)

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

Copy constructor

Parameters:

const	CExperimentSet & src
const	CCopasiContainer * pParent (default: src data model)

CExperimentSet::CExperimentSet	(	const CCopasiParameterGroup &	group,
		const CCopasiContainer *	pParent = NULL
	)

Specific constructor used for reading COPASI files

Parameters:

const	CCopasiParameterGroup & group
const	CCopasiContainer * pParent (default: group data model)

CExperimentSet::~CExperimentSet

(

)

[virtual]

Destructor

---

Member Function Documentation

CExperiment * CExperimentSet::addExperiment

(

const CExperiment &

experiment

)

Add an experiment

Returns:

CExperiment * experiment

bool CExperimentSet::calculateStatistics

(

)

Calculate statistics across all experiments.

Returns:

bool success

bool CExperimentSet::compile

(

const std::vector< CCopasiContainer * >

listOfContainer = CCopasiContainer::EmptyList

)

Compile the experiment set. This function must be called before any evaluations can be performed.

Parameters:

const

std::vector< CCopasiContainer * > listOfContainer

Returns:

bool success

bool CExperimentSet::elevateChildren

(

)

[virtual]

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

Returns:

bool success

Reimplemented from CCopasiParameterGroup.

unsigned C_INT32 CExperimentSet::getDataPointCount

(

)

const

Retreive the number of data points of all experiments combined.

Returns:

unsigned C_INT32 dataPointCount

const CMatrix< C_FLOAT64 > & CExperimentSet::getDependentData

(

const unsigned C_INT32 &

index

)

const

Retrieve the dependent data of the indexed experiment.

Parameters:

const

unsigned C_INT32 & index,

Returns:

const CMatrix< C_FLOAT64 > & dependentData

const CVector< C_FLOAT64 > & CExperimentSet::getDependentErrorMean

(

)

const

Retrieve all dependent data error mean values.

Returns:

const CVector< C_FLOAT64 > & dependentErrorMean

const CVector< C_FLOAT64 > & CExperimentSet::getDependentErrorMeanSD

(

)

const

Retrieve all dependent data error mean std. deviations.

Returns:

const CVector< C_FLOAT64 > & dependentErrorMeanSD

const CVector< C_FLOAT64 > & CExperimentSet::getDependentObjectiveValues

(

)

const

Retrieve all dependent data objective values.

Returns:

const CVector< C_FLOAT64 > & dependentObjectiveValues

const CVector< CCopasiObject * > & CExperimentSet::getDependentObjects

(

)

const

Retrieve the list of dependent data objects

Returns:

const std::vector< CCopasiObject * > & dependentObjects

const CVector< C_FLOAT64 > & CExperimentSet::getDependentRMS

(

)

const

Retrieve all dependent data objective values.

Returns:

const CVector< C_FLOAT64 > & dependentRMS

CExperiment * CExperimentSet::getExperiment

(

const unsigned C_INT32 &

index

)

Retrieve the indexed experiment

Parameters:

const

unsigned C_INT32 & index,

Returns:

CExperiment * experiment

const CExperiment * CExperimentSet::getExperiment

(

const unsigned C_INT32 &

index

)

const

Retrieve the indexed experiment

Parameters:

const

unsigned C_INT32 & index,

Returns:

const CExperiment * experiment

CExperiment * CExperimentSet::getExperiment

(

const std::string &

name

)

Retrieve the indexed experiment

Parameters:

const

std::string & name,

Returns:

CExperiment * experiment

const CExperiment * CExperimentSet::getExperiment

(

const std::string &

name

)

const

Retrieve the indexed experiment

Parameters:

const

std::string & name,

Returns:

const CExperiment * experiment

unsigned C_INT32 CExperimentSet::getExperimentCount

(

)

const

Retreive the number of the experiments in the set

Returns:

unsigned C_INT32 experimentCount

const CCopasiTask::Type & CExperimentSet::getExperimentType

(

const unsigned C_INT32 &

index

)

const

Retrieve the indexed experiment type

Parameters:

const

unsigned C_INT32 & index,

Returns:

const CCopasiTasK::Type & experimentType

std::vector< std::string > CExperimentSet::getFileNames

(

)

const

Retrieve the list of file names

Returns:

std::vector< std::string > fileNames

const CMatrix< C_FLOAT64 > & CExperimentSet::getIndependentData

(

const unsigned C_INT32 &

index

)

const

Retrieve the independent data of the indexed experiment.

Parameters:

const

unsigned C_INT32 & index,

Returns:

const CMatrix< C_FLOAT64 > & independentData

bool CExperimentSet::hasDataForTaskType

(

const CCopasiTask::Type &

type

)

const

Check whether the set contains data for the the given task type

Parameters:

const

CCopasiTask::Type & type

Returns:

bool hasDataForTaskType

unsigned C_INT32 CExperimentSet::keyToIndex

(

const std::string &

key

)

const

Convert an experiment key to an index

Parameters:

const

std::string & key

Returns:

unsigned C_INT32 index

void CExperimentSet::removeExperiment

(

const unsigned C_INT32 &

index

)

Remove an experiment from the set

Parameters:

const

unsigned C_INT32 & index

void CExperimentSet::sort

(

)

Sort the experiments in the set

---

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

• copasi/parameterFitting/CExperimentSet.h
• copasi/parameterFitting/CExperimentSet.cpp