CScanItemRepeat Class Reference

#include <CScanMethod.h>

Inheritance diagram for CScanItemRepeat:

Collaboration diagram for CScanItemRepeat:

Public Member Functions
	CScanItemRepeat (CCopasiParameterGroup *si, const bool &continueFromCurrentState)
virtual bool	isValidScanItem (const bool &continueFromCurrentState)
virtual void	step ()
virtual	~CScanItemRepeat ()
Public Member Functions inherited from CScanItem
size_t	getNumSteps () const
const CCopasiObject *	getObject () const
bool	isFinished () const
virtual bool	isNesting () const
void	reset ()
void	restoreValue () const
void	storeValue ()
virtual	~CScanItem ()

Additional Inherited Members
Static Public Member Functions inherited from CScanItem
static CScanItem *	createScanItemFromParameterGroup (CCopasiParameterGroup *si, CRandom *rg, const bool &continueFromCurrentState)
Protected Member Functions inherited from CScanItem
	CScanItem (CCopasiParameterGroup *si, const bool &continueFromCurrentState)
Protected Attributes inherited from CScanItem
bool	mFlagFinished
size_t	mIndex
bool	mIsStateVariable
size_t	mNumSteps
CCopasiObject *	mpInitialObject
CCopasiObject *	mpObject
C_FLOAT64	mStoreValue

Detailed Description

Definition at line 99 of file CScanMethod.h.

Constructor & Destructor Documentation

CScanItemRepeat::CScanItemRepeat	(	CCopasiParameterGroup *	si,
		const bool &	continueFromCurrentState
	)

Definition at line 183 of file CScanMethod.cpp.

References CScanItem::mNumSteps.

                                                                       :
  CScanItem(si, continueFromCurrentState)
{
  if (mNumSteps >= 1)
    --mNumSteps; // for the repeat item mNumSteps is the number of iterations, not of intervals
}

virtual CScanItemRepeat::~CScanItemRepeat ( )

inlinevirtual

Definition at line 105 of file CScanMethod.h.

{};

Member Function Documentation

bool CScanItemRepeat::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

Parameters

const

bool & continueFromCurrentState

Reimplemented from CScanItem.

Definition at line 202 of file CScanMethod.cpp.

{
  return true;
}

void CScanItemRepeat::step ( )

virtual

Implements CScanItem.

Definition at line 191 of file CScanMethod.cpp.

References CScanItem::mFlagFinished, CScanItem::mIndex, and CScanItem::mNumSteps.

{
  //do something ...

  //the index
  if (mIndex > mNumSteps)
    mFlagFinished = true;

  ++mIndex;
}

---

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

• CScanMethod.h
• CScanMethod.cpp