COPASI API
4.16.103
|
#include <CScanMethod.h>
Public Member Functions | |
size_t | getTotalNumberOfSteps () const |
bool | init () |
virtual bool | isValidProblem (const CCopasiProblem *pProblem) |
bool | scan () |
void | setProblem (CScanProblem *problem) |
~CScanMethod () | |
![]() | |
CCopasiMethod (const CCopasiMethod &src, const CCopasiContainer *pParent=NULL) | |
const CCopasiMethod::SubType & | getSubType () const |
const CCopasiTask::Type & | getType () const |
virtual void | load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::SEARCH) |
virtual void | print (std::ostream *ostream) const |
virtual void | printResult (std::ostream *ostream) const |
virtual bool | setCallBack (CProcessReport *pCallBack) |
virtual | ~CCopasiMethod () |
![]() | |
bool | addGroup (const std::string &name) |
bool | addParameter (const CCopasiParameter ¶meter) |
bool | addParameter (const std::string &name, const CCopasiParameter::Type type) |
template<class CType > | |
bool | addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value) |
void | addParameter (CCopasiParameter *pParameter) |
CCopasiParameterGroup * | assertGroup (const std::string &name) |
template<class CType > | |
CCopasiParameter * | assertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue) |
index_iterator | beginIndex () const |
name_iterator | beginName () const |
CCopasiParameterGroup (const CCopasiParameterGroup &src, const CCopasiContainer *pParent=NULL) | |
CCopasiParameterGroup (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &objectType="ParameterGroup") | |
void | clear () |
virtual bool | elevateChildren () |
index_iterator | endIndex () const |
name_iterator | endName () const |
CCopasiParameterGroup * | getGroup (const std::string &name) |
const CCopasiParameterGroup * | getGroup (const std::string &name) const |
CCopasiParameterGroup * | getGroup (const size_t &index) |
const CCopasiParameterGroup * | getGroup (const size_t &index) const |
size_t | getIndex (const std::string &name) const |
std::string | getKey (const std::string &name) const |
std::string | getKey (const size_t &index) const |
virtual const std::string & | getName (const size_t &index) const |
virtual const CObjectInterface * | getObject (const CCopasiObjectName &cn) const |
CCopasiParameter * | getParameter (const std::string &name) |
const CCopasiParameter * | getParameter (const std::string &name) const |
CCopasiParameter * | getParameter (const size_t &index) |
const CCopasiParameter * | getParameter (const size_t &index) const |
CCopasiParameter::Type | getType (const std::string &name) const |
CCopasiParameter::Type | getType (const size_t &index) const |
std::string | getUniqueParameterName (const CCopasiParameter *pParameter) const |
const CCopasiParameter::Value & | getValue (const std::string &name) const |
const CCopasiParameter::Value & | getValue (const size_t &index) const |
CCopasiParameter::Value & | getValue (const std::string &name) |
CCopasiParameter::Value & | getValue (const size_t &index) |
CCopasiParameterGroup & | operator= (const CCopasiParameterGroup &rhs) |
bool | removeParameter (const std::string &name) |
bool | removeParameter (const size_t &index) |
template<class CType > | |
bool | setValue (const std::string &name, const CType &value) |
template<class CType > | |
bool | setValue (const size_t &index, const CType &value) |
size_t | size () const |
bool | swap (const size_t &iFrom, const size_t &iTo) |
bool | swap (index_iterator &from, index_iterator &to) |
virtual | ~CCopasiParameterGroup () |
![]() | |
CCopasiParameter (const CCopasiParameter &src, const CCopasiContainer *pParent=NULL) | |
CCopasiParameter (const std::string &name, const Type &type, const void *pValue=NULL, const CCopasiContainer *pParent=NULL, const std::string &objectType="Parameter") | |
virtual CCopasiObjectName | getCN () const |
virtual const std::string & | getKey () const |
virtual std::string | getObjectDisplayName (bool regular=true, bool richtext=false) const |
const CCopasiParameter::Type & | getType () const |
const Value & | getValue () const |
Value & | getValue () |
virtual void * | getValuePointer () const |
CCopasiObject * | getValueReference () const |
bool | isValidValue (const C_FLOAT64 &value) const |
bool | isValidValue (const C_INT32 &value) const |
bool | isValidValue (const unsigned C_INT32 &value) const |
bool | isValidValue (const bool &value) const |
bool | isValidValue (const std::string &value) const |
bool | isValidValue (const CCopasiObjectName &value) const |
bool | isValidValue (const std::vector< CCopasiParameter * > &value) const |
CCopasiParameter & | operator= (const CCopasiParameter &rhs) |
template<class CType > | |
bool | setValue (const CType &value) |
bool | setValue (const std::vector< CCopasiParameter * > &value) |
virtual | ~CCopasiParameter () |
![]() | |
virtual bool | add (CCopasiObject *pObject, const bool &adopt=true) |
CCopasiContainer (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=CCopasiObject::Container) | |
CCopasiContainer (const CCopasiContainer &src, const CCopasiContainer *pParent=NULL) | |
virtual std::string | getChildObjectUnits (const CCopasiObject *pObject) const |
virtual const objectMap & | getObjects () const |
virtual std::string | getUnits () const |
virtual const CCopasiObject * | getValueObject () const |
virtual bool | remove (CCopasiObject *pObject) |
virtual | ~CCopasiContainer () |
![]() | |
void | addDirectDependency (const CCopasiObject *pObject) |
CCopasiObject (const CCopasiObject &src, const CCopasiContainer *pParent=NULL) | |
void | clearDirectDependencies () |
void | clearRefresh () |
bool | dependsOn (DataObjectSet candidates, const DataObjectSet &context=DataObjectSet()) const |
void | getAllDependencies (DataObjectSet &dependencies, const DataObjectSet &context) const |
virtual const DataObjectSet & | getDirectDependencies (const DataObjectSet &context=DataObjectSet()) const |
CCopasiContainer * | getObjectAncestor (const std::string &type) const |
CCopasiDataModel * | getObjectDataModel () |
const CCopasiDataModel * | getObjectDataModel () const |
const std::string & | getObjectName () const |
CCopasiContainer * | getObjectParent () const |
const std::string & | getObjectType () const |
virtual const CObjectInterface::ObjectSet & | getPrerequisites () const |
virtual Refresh * | getRefresh () const |
UpdateMethod * | getUpdateMethod () const |
bool | hasCircularDependencies (DataObjectSet &candidates, DataObjectSet &verified, const DataObjectSet &context) const |
bool | hasUpdateMethod () const |
bool | isArray () const |
bool | isContainer () const |
bool | isDataModel () const |
bool | isMatrix () const |
bool | isNameVector () const |
bool | isNonUniqueName () const |
virtual bool | isPrerequisiteForContext (const CObjectInterface *pObject, const CMath::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const |
bool | isReference () const |
bool | isRoot () const |
bool | isSeparator () const |
bool | isStaticString () const |
bool | isValueBool () const |
bool | isValueDbl () const |
bool | isValueInt () const |
bool | isValueInt64 () const |
bool | isValueString () const |
bool | isVector () const |
virtual bool | mustBeDeleted (const DataObjectSet &deletedObjects) const |
void | removeDirectDependency (const CCopasiObject *pObject) |
void | setDirectDependencies (const DataObjectSet &directDependencies) |
bool | setObjectName (const std::string &name) |
virtual bool | setObjectParent (const CCopasiContainer *pParent) |
void | setObjectValue (const C_FLOAT64 &value) |
void | setObjectValue (const C_INT32 &value) |
void | setObjectValue (const bool &value) |
template<class CType > | |
void | setRefresh (CType *pType, void(CType::*method)(void)) |
template<class CType > | |
void | setUpdateMethod (CType *pType, void(CType::*method)(const C_FLOAT64 &)) |
template<class CType > | |
void | setUpdateMethod (CType *pType, void(CType::*method)(const C_INT32 &)) |
template<class CType > | |
void | setUpdateMethod (CType *pType, void(CType::*method)(const bool &)) |
virtual | ~CCopasiObject () |
![]() | |
CObjectInterface () | |
virtual | ~CObjectInterface () |
Static Public Member Functions | |
static CScanMethod * | createMethod (CCopasiMethod::SubType subType=CCopasiMethod::scanMethod) |
![]() | |
static std::vector< Refresh * > | buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet()) |
static void | setRenameHandler (CRenameHandler *rh) |
Protected Member Functions | |
CScanMethod (CCopasiMethod::SubType subType, const CCopasiContainer *pParent=NULL) | |
![]() | |
CCopasiMethod (const CCopasiTask::Type &taskType, const SubType &subType, const CCopasiContainer *pParent=NULL) | |
![]() | |
CCopasiParameterGroup () | |
![]() | |
template<class CType > | |
CCopasiObject * | addMatrixReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0) |
template<class CType > | |
CCopasiObject * | addObjectReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0) |
template<class CType > | |
CCopasiObject * | addVectorReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0) |
void | initObjects () |
![]() | |
CCopasiObject () | |
CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0) | |
Protected Attributes | |
bool | mContinueFromCurrentState |
std::vector< Refresh * > | mInitialRefreshes |
size_t | mLastNestingItem |
CScanProblem * | mpProblem |
CRandom * | mpRandomGenerator |
CScanTask * | mpTask |
std::vector< CScanItem * > | mScanItems |
size_t | mTotalSteps |
![]() | |
CProcessReport * | mpCallBack |
![]() | |
std::string | mKey |
CCopasiObject * | mpValueReference |
size_t | mSize |
Value | mValue |
![]() | |
objectMap | mObjects |
Private Member Functions | |
bool | calculate () |
bool | cleanupScanItems () |
CScanMethod () | |
bool | loop (size_t level) |
Definition at line 159 of file CScanMethod.h.
|
private |
Default constructor.
Definition at line 353 of file CScanMethod.cpp.
References CRandom::createGenerator(), mpRandomGenerator, and CRandom::r250.
Referenced by createMethod().
|
protected |
Specific constructor.
CCopasiMethod::SubType | subType |
const | CCopasiContainer * pParent (default: NULL) |
CScanMethod::~CScanMethod | ( | ) |
Copy constructor.
const CTrajectoryMethod & | src Destructor. |
Definition at line 365 of file CScanMethod.cpp.
References cleanupScanItems(), and mpRandomGenerator.
|
private |
Definition at line 508 of file CScanMethod.cpp.
References mInitialRefreshes, mpTask, and CScanTask::processCallback().
Referenced by loop(), and scan().
|
private |
Definition at line 372 of file CScanMethod.cpp.
References mpProblem, and mScanItems.
Referenced by init(), and ~CScanMethod().
|
static |
Create a trajectory method. Note: the returned object has to be released after use with delete
Definition at line 348 of file CScanMethod.cpp.
References CScanMethod().
Referenced by CScanTask::createMethod().
|
inline |
Definition at line 243 of file CScanMethod.h.
References mTotalSteps.
Referenced by CScanTask::process().
bool CScanMethod::init | ( | ) |
Definition at line 384 of file CScanMethod.cpp.
References CModel::buildInitialRefreshSequence(), CCopasiObject::buildUpdateSequence(), C_INVALID_INDEX, cleanupScanItems(), CScanItem::createScanItemFromParameterGroup(), CScanProblem::getContinueFromCurrentState(), CCopasiProblem::getModel(), CScanProblem::getNumberOfScanItems(), CScanItem::getNumSteps(), CScanItem::getObject(), CCopasiObject::getObjectParent(), CScanProblem::getScanItem(), CModel::getUptoDateObjects(), mContinueFromCurrentState, mInitialRefreshes, mLastNestingItem, mpProblem, mpRandomGenerator, mpTask, mScanItems, and mTotalSteps.
Referenced by CScanTask::process().
|
virtual |
The main scan method. Check if the method is suitable for this problem
Reimplemented from CCopasiMethod.
Definition at line 523 of file CScanMethod.cpp.
References CScanItem::createScanItemFromParameterGroup(), CCopasiMessage::ERROR, CCopasiMessage::EXCEPTION, CScanProblem::getContinueFromCurrentState(), CScanProblem::getNumberOfScanItems(), CScanProblem::getScanItem(), CCopasiMethod::isValidProblem(), CScanItem::isValidScanItem(), mContinueFromCurrentState, mpProblem, mpRandomGenerator, and CCopasiMessage::WARNING.
|
private |
Definition at line 481 of file CScanMethod.cpp.
References calculate(), CCopasiObject::getObjectParent(), CScanItem::isFinished(), CScanItem::isNesting(), mLastNestingItem, mScanItems, CScanItem::reset(), and CScanItem::step().
Referenced by scan().
bool CScanMethod::scan | ( | ) |
Definition at line 453 of file CScanMethod.cpp.
References calculate(), loop(), mpProblem, and mScanItems.
Referenced by CScanTask::process().
void CScanMethod::setProblem | ( | CScanProblem * | problem | ) |
Set a pointer to the problem. This method is used by CTrajectory
CTrajectoryProblem * | problem |
Definition at line 519 of file CScanMethod.cpp.
References mpProblem.
Referenced by CScanTask::process().
|
protected |
Variable indicating whether the subtask shall continue from the current state or the initial state
Definition at line 195 of file CScanMethod.h.
Referenced by init(), and isValidProblem().
|
protected |
Definition at line 179 of file CScanMethod.h.
Referenced by calculate(), and init().
|
protected |
the index of the last item that has several subitems, also the last item that need to generate output separators
Definition at line 189 of file CScanMethod.h.
|
protected |
A pointer to the trajectory problem.
Definition at line 165 of file CScanMethod.h.
Referenced by cleanupScanItems(), init(), isValidProblem(), scan(), and setProblem().
|
protected |
A pointer to the random number generator
Definition at line 175 of file CScanMethod.h.
Referenced by CScanMethod(), init(), isValidProblem(), and ~CScanMethod().
|
protected |
A pointer to the scan Task.
Definition at line 170 of file CScanMethod.h.
Referenced by calculate(), and init().
|
protected |
Definition at line 177 of file CScanMethod.h.
Referenced by cleanupScanItems(), init(), loop(), and scan().
|
protected |
Definition at line 183 of file CScanMethod.h.
Referenced by getTotalNumberOfSteps(), and init().