CScanItem Class Reference

#include <CScanMethod.h>

Inheritance diagram for CScanItem:

Public Member Functions
size_t	getNumSteps () const
const CObjectInterface *	getObject () const
bool	isFinished () const
virtual bool	isNesting () const
virtual bool	isValidScanItem (const bool &continueFromCurrentState)
void	reset ()
void	restoreValue () const
virtual void	step ()=0
void	storeValue ()
virtual	~CScanItem ()

Static Public Member Functions
static CScanItem *	createScanItemFromParameterGroup (CCopasiParameterGroup *si, CRandom *rg)

Protected Member Functions
	CScanItem (CCopasiParameterGroup *si)
virtual void	ensureParameterGroupHasAllElements (CCopasiParameterGroup *pg)

Protected Attributes
bool	mFlagFinished
size_t	mIndex
size_t	mNumSteps
const CObjectInterface *	mpObject
C_FLOAT64 *	mpObjectValue
C_FLOAT64	mStoreValue

Private Member Functions
	CScanItem ()

Constructor & Destructor Documentation

~CScanItem()

CScanItem::~CScanItem ( )

virtual

CScanItem() [1/2]

CScanItem::CScanItem ( CCopasiParameterGroup *  si )

protected

References C_FLOAT64, C_INT32, ensureParameterGroupHasAllElements(), CObjectInterface::getObject(), CDataObject::getObjectAncestor(), CCopasiParameterGroup::getValue(), CObjectInterface::getValuePointer(), mNumSteps, mpObject, and mpObjectValue.

CScanItem() [2/2]

CScanItem::CScanItem ( )

private

Member Function Documentation

createScanItemFromParameterGroup()

CScanItem * CScanItem::createScanItemFromParameterGroup ( CCopasiParameterGroup *  si, CRandom *  rg  )

static

CScanMethod class. This class describes the Scan method

Created for COPASI by Rohan Luktuke 2002

References C_INT32, CCopasiParameterGroup::getValue(), CScanProblem::SCAN_LINEAR, CScanProblem::SCAN_RANDOM, and CScanProblem::SCAN_REPEAT.

Referenced by CScanMethod::init(), and CScanMethod::isValidProblem().

ensureParameterGroupHasAllElements()

void CScanItem::ensureParameterGroupHasAllElements ( CCopasiParameterGroup *  pg )

protectedvirtual

Reimplemented in CScanItemRandom, and CScanItemLinear.

References CCopasiParameterGroup::assertParameter(), CCopasiParameter::CN, and CCopasiParameter::UINT.

Referenced by CScanItem().

getNumSteps()

size_t CScanItem::getNumSteps

(

)

const

References mNumSteps.

Referenced by CScanMethod::init().

getObject()

const CObjectInterface * CScanItem::getObject

(

)

const

Retrieve the initial object which is scanned.

Returns

const CObjectInterface * object

References mpObject.

Referenced by CScanMethod::init().

isFinished()

bool CScanItem::isFinished

(

)

const

References mFlagFinished.

Referenced by CScanMethod::loop().

isNesting()

bool CScanItem::isNesting ( ) const

virtual

Reimplemented in CScanItemRandom.

Referenced by CScanMethod::loop().

isValidScanItem()

bool CScanItem::isValidScanItem ( const bool &  continueFromCurrentState )

virtual

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

Reimplemented in CScanItemLinear, and CScanItemRepeat.

References CCopasiMessage::ERROR, and mpObject.

Referenced by CScanMethod::isValidProblem(), and CScanItemLinear::isValidScanItem().

reset()

void CScanItem::reset

(

)

References mFlagFinished, mIndex, and step().

Referenced by CScanMethod::loop().

restoreValue()

void CScanItem::restoreValue

(

)

const

References mpObjectValue, and mStoreValue.

step()

virtual void CScanItem::step ( )

pure virtual

Implemented in CScanItemRandom, CScanItemLinear, and CScanItemRepeat.

Referenced by CScanMethod::loop(), and reset().

storeValue()

void CScanItem::storeValue

(

)

References mpObjectValue, and mStoreValue.

Member Data Documentation

mFlagFinished

bool CScanItem::mFlagFinished

protected

Referenced by isFinished(), reset(), CScanItemRepeat::step(), CScanItemLinear::step(), and CScanItemRandom::step().

mIndex

size_t CScanItem::mIndex

protected

Referenced by reset(), CScanItemRepeat::step(), CScanItemLinear::step(), and CScanItemRandom::step().

mNumSteps

size_t CScanItem::mNumSteps

protected

Referenced by CScanItem(), CScanItemLinear::CScanItemLinear(), CScanItemRandom::CScanItemRandom(), CScanItemRepeat::CScanItemRepeat(), getNumSteps(), CScanItemRepeat::step(), CScanItemLinear::step(), and CScanItemRandom::step().

mpObject

const CObjectInterface* CScanItem::mpObject

protected

Referenced by CScanItem(), getObject(), and isValidScanItem().

mpObjectValue

C_FLOAT64* CScanItem::mpObjectValue

protected

Referenced by CScanItem(), restoreValue(), CScanItemLinear::step(), CScanItemRandom::step(), and storeValue().

mStoreValue

C_FLOAT64 CScanItem::mStoreValue

protected

Referenced by restoreValue(), and storeValue().

---

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

• CScanMethod.h
• CScanMethod.cpp