COPASI API
4.16.103
|
#include <CScanMethod.h>
Public Member Functions | |
size_t | getNumSteps () const |
const CCopasiObject * | 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, const bool &continueFromCurrentState) |
Protected Member Functions | |
CScanItem (CCopasiParameterGroup *si, const bool &continueFromCurrentState) | |
Protected Attributes | |
bool | mFlagFinished |
size_t | mIndex |
bool | mIsStateVariable |
size_t | mNumSteps |
CCopasiObject * | mpInitialObject |
CCopasiObject * | mpObject |
C_FLOAT64 | mStoreValue |
Private Member Functions | |
CScanItem () | |
Definition at line 36 of file CScanMethod.h.
|
inlinevirtual |
Definition at line 72 of file CScanMethod.h.
|
protected |
Definition at line 83 of file CScanMethod.cpp.
References CModel::getCorrespondingTransientObject(), CCopasiDataModel::getDataObject(), CCopasiObject::getObjectAncestor(), CCopasiObject::getObjectDataModel(), CCopasiParameterGroup::getValue(), CModel::isStateVariable(), CCopasiObject::isValueDbl(), mIsStateVariable, mNumSteps, mpInitialObject, mpObject, CCopasiParameter::Value::pCN, and CCopasiParameter::Value::pUINT.
|
private |
Definition at line 73 of file CScanMethod.cpp.
|
static |
CScanMethod class. This class describes the Scan method
Created for COPASI by Rohan Luktuke 2002
Definition at line 48 of file CScanMethod.cpp.
References CCopasiParameterGroup::getValue(), CCopasiParameter::Value::pUINT, CScanProblem::SCAN_LINEAR, CScanProblem::SCAN_RANDOM, and CScanProblem::SCAN_REPEAT.
Referenced by CScanMethod::init(), and CScanMethod::isValidProblem().
size_t CScanItem::getNumSteps | ( | ) | const |
Definition at line 131 of file CScanMethod.cpp.
References mNumSteps.
Referenced by CScanMethod::init().
const CCopasiObject * CScanItem::getObject | ( | ) | const |
Retrieve the initial object which is scanned.
Definition at line 176 of file CScanMethod.cpp.
References mpObject.
Referenced by CScanMethod::init().
bool CScanItem::isFinished | ( | ) | const |
Definition at line 155 of file CScanMethod.cpp.
References mFlagFinished.
Referenced by CScanMethod::loop().
|
inlinevirtual |
Reimplemented in CScanItemRandom.
Definition at line 70 of file CScanMethod.h.
Referenced by CScanMethod::loop().
|
virtual |
perform checks. This is used in the method::isValidProblem() method. It returns false for an invalid ScanItem and generates a CCopasiMessage
const | bool & continueFromCurrentState |
Reimplemented in CScanItemLinear, and CScanItemRepeat.
Definition at line 157 of file CScanMethod.cpp.
References CCopasiMessage::ERROR, CCopasiObject::getObjectDisplayName(), MCScan, mIsStateVariable, mpInitialObject, mpObject, and CCopasiMessage::WARNING.
Referenced by CScanMethod::isValidProblem(), and CScanItemLinear::isValidScanItem().
void CScanItem::reset | ( | ) |
Definition at line 148 of file CScanMethod.cpp.
References mFlagFinished, mIndex, and step().
Referenced by CScanMethod::loop().
void CScanItem::restoreValue | ( | ) | const |
Definition at line 133 of file CScanMethod.cpp.
References mpObject, mStoreValue, and CCopasiObject::setObjectValue().
|
pure virtual |
Implemented in CScanItemRandom, CScanItemLinear, and CScanItemRepeat.
Referenced by CScanMethod::loop(), and reset().
void CScanItem::storeValue | ( | ) |
Definition at line 139 of file CScanMethod.cpp.
References C_FLOAT64, CCopasiObject::getValuePointer(), CCopasiObject::isValueDbl(), mpObject, and mStoreValue.
|
protected |
Definition at line 48 of file CScanMethod.h.
Referenced by isFinished(), reset(), CScanItemRepeat::step(), CScanItemLinear::step(), and CScanItemRandom::step().
|
protected |
Definition at line 46 of file CScanMethod.h.
Referenced by reset(), CScanItemRepeat::step(), CScanItemLinear::step(), and CScanItemRandom::step().
|
protected |
Definition at line 50 of file CScanMethod.h.
Referenced by CScanItem(), and isValidScanItem().
|
protected |
Definition at line 39 of file CScanMethod.h.
Referenced by CScanItem(), CScanItemLinear::CScanItemLinear(), CScanItemRandom::CScanItemRandom(), CScanItemRepeat::CScanItemRepeat(), getNumSteps(), CScanItemRepeat::step(), CScanItemLinear::step(), and CScanItemRandom::step().
|
protected |
Definition at line 42 of file CScanMethod.h.
Referenced by CScanItem(), isValidScanItem(), CScanItemLinear::step(), and CScanItemRandom::step().
|
protected |
Definition at line 41 of file CScanMethod.h.
Referenced by CScanItem(), getObject(), isValidScanItem(), restoreValue(), CScanItemLinear::step(), CScanItemRandom::step(), and storeValue().
|
protected |
Definition at line 44 of file CScanMethod.h.
Referenced by restoreValue(), and storeValue().