CScanItem Class Reference

#include <CScanMethod.h>

Inheritance diagram for CScanItem:

List of all members.

Public Member Functions
unsigned C_INT32	getNumSteps () const
void	restoreValue () const
void	storeValue ()
virtual void	reset ()
virtual void	step ()=0
virtual bool	isFinished () const
virtual bool	isNesting () const
virtual	~CScanItem ()
virtual bool	isValidScanItem ()
const CCopasiObject *	getObject () const
Static Public Member Functions
static CScanItem *	createScanItemFromParameterGroup (CCopasiParameterGroup *si, CRandom *rg, CScanTask *st)
Protected Member Functions
	CScanItem (CCopasiParameterGroup *si)
Protected Attributes
unsigned C_INT32	mNumSteps
CCopasiObject *	mpValue
C_FLOAT64	mStoreValue
unsigned C_INT32	mIndex
bool	mFlagFinished

---

Constructor & Destructor Documentation

virtual CScanItem::~CScanItem

(

)

[inline, virtual]

CScanItem::CScanItem

(

CCopasiParameterGroup *

si

)

[protected]

---

Member Function Documentation

CScanItem * CScanItem::createScanItemFromParameterGroup	(	CCopasiParameterGroup *	si,
		CRandom *	rg,
		CScanTask *	st
	)		[static]

CScanMethod class. This class describes the Scan method

Created for Copasi by Rohan Luktuke 2002

unsigned C_INT32 CScanItem::getNumSteps

(

)

const

const CCopasiObject * CScanItem::getObject

(

)

const

Retrieve the object which is scanned by the item.

Returns:

const CCopasiObject * object

bool CScanItem::isFinished

(

)

const [virtual]

virtual bool CScanItem::isNesting

(

)

const [inline, virtual]

Reimplemented in CScanItemRandom.

bool CScanItem::isValidScanItem

(

)

[virtual]

perform checks. This is used in the method::isValidProblem() method. It returns false for an invalid ScanItem and generates a CCopasiMessage

Reimplemented in CScanItemRandom, and CScanItemLinear.

void CScanItem::reset

(

)

[virtual]

void CScanItem::restoreValue

(

)

const

virtual void CScanItem::step

(

)

[pure virtual]

Implemented in CScanItemRandom, CScanItemLinear, and CScanItemRepeat.

void CScanItem::storeValue

(

)

---

Member Data Documentation

bool CScanItem::mFlagFinished [protected]

unsigned C_INT32 CScanItem::mIndex [protected]

unsigned C_INT32 CScanItem::mNumSteps [protected]

CCopasiObject* CScanItem::mpValue [protected]

C_FLOAT64 CScanItem::mStoreValue [protected]

---

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

• copasi/scan/CScanMethod.h
• copasi/scan/CScanMethod.cpp