CFitItem Class Reference

#include <CFitItem.h>

Inheritance diagram for CFitItem:

List of all members.

Public Member Functions
	CFitItem (const CCopasiContainer *pParent, const std::string &name="FitItem")
	CFitItem (const CFitItem &src, const CCopasiContainer *pParent=NULL)
	CFitItem (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
virtual	~CFitItem ()
virtual bool	elevateChildren ()
virtual UpdateMethod *	getUpdateMethod () const
virtual bool	isValid () const
virtual bool	compile (const std::vector< CCopasiContainer * > listOfContainer=CCopasiContainer::EmptyList)
virtual C_INT32	checkConstraint () const
virtual C_FLOAT64	getConstraintViolation () const
void	setLocalValue (const C_FLOAT64 &value)
const C_FLOAT64 &	getLocalValue () const
virtual const C_FLOAT64 *	getObjectValue () const
bool	addExperiment (const std::string &key)
const std::string &	getExperiment (const unsigned C_INT32 &index) const
bool	removeExperiment (const unsigned C_INT32 &index)
unsigned C_INT32	getExperimentCount () const
std::string	getExperiments () const
bool	updateBounds (std::vector< COptItem * >::iterator it)
Static Public Member Functions
static bool	isValid (CCopasiParameterGroup &group)
Protected Member Functions
	CFitItem ()
Protected Attributes
CCopasiParameterGroup *	mpGrpAffectedExperiments
C_FLOAT64	mLocalValue
UpdateMethod *	mpLocalMethod
Friends
class	CFitProblem
std::ostream &	operator<< (std::ostream &os, const CFitItem &o)

---

Constructor & Destructor Documentation

CFitItem::CFitItem

(

)

[protected]

Default constructor

CFitItem::CFitItem	(	const CCopasiContainer *	pParent,
		const std::string &	name = "FitItem"
	)

Specific constructor

Parameters:

const	CCopasiContainer * pParent (default: NULL)
const	std::string & name (default: FitItem)

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

Copy constructor

Parameters:

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

CFitItem::CFitItem	(	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)

CFitItem::~CFitItem

(

)

[virtual]

Destructor

---

Member Function Documentation

bool CFitItem::addExperiment

(

const std::string &

key

)

Add an experiment to the list of affected experiments.

Parameters:

const

std::string & key

Returns:

bool success

C_INT32 CFitItem::checkConstraint

(

)

const [virtual]

This functions check whether the current value is within the limits of the optimization item.

Returns:

C_INT32 result (-1: to small, 0: within boundaries, 1 to large)

Reimplemented from COptItem.

Reimplemented in CFitConstraint.

bool CFitItem::compile

(

const std::vector< CCopasiContainer * >

listOfContainer = CCopasiContainer::EmptyList

)

[virtual]

Compile the optimization item. This function must be called before any of the check functions are called.

Parameters:

const

std::vector< CCopasiContainer * > listOfContainer

Returns:

bool success

Reimplemented from COptItem.

bool CFitItem::elevateChildren

(

)

[virtual]

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

Returns:

bool success

Reimplemented from CCopasiParameterGroup.

C_FLOAT64 CFitItem::getConstraintViolation

(

)

const [virtual]

Retrieve the magnitude of the constraint violation This is always a positive number

Returns:

C_FLOAT64 constraintViolation;

Reimplemented from COptItem.

Reimplemented in CFitConstraint.

const std::string & CFitItem::getExperiment

(

const unsigned C_INT32 &

index

)

const

Retreive the key of the indexed experiment.

Parameters:

const

unsigned C_INT32 & index

Returns:

const std::string & key

unsigned C_INT32 CFitItem::getExperimentCount

(

)

const

Retrieve the number of experiments

Returns:

unsigned C_INT32 size

std::string CFitItem::getExperiments

(

)

const

Retrieve a string listing all experiments the item applies to

Returns:

std::string experiments

const C_FLOAT64 & CFitItem::getLocalValue

(

)

const

Retreive the local value.

Returns:

const C_FLOAT64 & value

const C_FLOAT64 * CFitItem::getObjectValue

(

)

const [virtual]

Retrieve the value of the optimization object.

Returns:

const C_FLOAT64 * objectValue

Reimplemented from COptItem.

UpdateMethod * CFitItem::getUpdateMethod

(

)

const [virtual]

Retrieve the update method

Returns:

UpdateMethod * pUpdateMethod

Reimplemented from COptItem.

bool CFitItem::isValid

(

)

const [virtual]

Check the validity of the optimization item.

Returns:

bool isValid

Reimplemented from COptItem.

bool CFitItem::isValid

(

CCopasiParameterGroup &

group

)

[static]

Check whether the group describes a valid optimization item.

Parameters:

CCopasiParameterGroup

& group

Returns:

bool isValid

Reimplemented from COptItem.

bool CFitItem::removeExperiment

(

const unsigned C_INT32 &

index

)

Remove the indexed experiment from the affected experiments

Parameters:

const

unsigned C_INT32 & index

Returns:

bool success

void CFitItem::setLocalValue

(

const C_FLOAT64 &

value

)

Set the local value.

Parameters:

const

C_FLOAT64 & value

bool CFitItem::updateBounds

(

std::vector< COptItem * >::iterator

it

)

Update bounds

Parameters:

std::vector<COptItem

* >::iterator it

Returns:

bool success

---

Friends And Related Function Documentation

friend class CFitProblem [friend]

std::ostream& operator<<	(	std::ostream &	os,
		const CFitItem &	o
	)		[friend]

Output stream operator

Parameters:

ostream	& os
const	CFitItem & A

Returns:

ostream & os

---

Member Data Documentation

C_FLOAT64 CFitItem::mLocalValue [protected]

The value for local items, which affect the experiments in the list.

CCopasiParameterGroup* CFitItem::mpGrpAffectedExperiments [protected]

A pointer to the value of the CCopasiParameterGroup holding the list of AffectedExperiments

UpdateMethod* CFitItem::mpLocalMethod [protected]

A pointer to the local update method

---

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

• copasi/parameterFitting/CFitItem.h
• copasi/parameterFitting/CFitItem.cpp