COPASI API  4.40.278
CScanProblem Class Reference

#include <CScanProblem.h>

Inheritance diagram for CScanProblem:
[legend]

Public Types

enum  Type { SCAN_REPEAT = 0 , SCAN_LINEAR , SCAN_RANDOM , SCAN_BREAK }
 
- Public Types inherited from CCopasiParameterGroup
typedef CDataObjectMap::const_type_iterator< CCopasiParameterconst_name_iterator
 
typedef std::vector< CCopasiParameter * > elements
 
typedef elements::iterator index_iterator
 
typedef CDataObjectMap::type_iterator< CCopasiParametername_iterator
 
- Public Types inherited from CCopasiParameter
enum class  eUserInterfaceFlag { editable , basic , unsupported , __SIZE }
 
enum class  Type {
  DOUBLE = 0 , UDOUBLE , INT , UINT ,
  BOOL , GROUP , STRING , CN ,
  KEY , FILE , EXPRESSION , INVALID ,
  __SIZE
}
 
typedef CFlags< eUserInterfaceFlagUserInterfaceFlag
 
- Public Types inherited from CDataContainer
typedef CDataObjectMap objectMap
 
- Public Types inherited from CDataObject
typedef std::set< const CDataObject * > DataObjectSet
 
enum  Flag {
  Container , Vector , Matrix , NameVector ,
  Reference , ValueBool , ValueInt , ValueInt64 ,
  ValueDbl , NonUniqueName , StaticString , ValueString ,
  Separator , DisplayName , ModelEntity , Array ,
  DataModel , Root , Gui , __SIZE
}
 
- Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * > ContainerList
 
typedef std::set< const CObjectInterface * > ObjectSet
 

Public Member Functions

CCopasiParameterGroupaddScanItem (CScanProblem::Type type, size_t steps=5, const CDataObject *obj=NULL)
 
void clearScanItems ()
 
 CScanProblem (const CDataContainer *pParent=NO_PARENT)
 
 CScanProblem (const CScanProblem &src, const CDataContainer *pParent)
 
void fixBuild81 ()
 
bool getContinueFromCurrentState () const
 
bool getContinueOnError () const
 
size_t getNumberOfScanItems () const
 
const bool & getOutputInSubtask () const
 
CCopasiParameterGroupgetScanItem (size_t index)
 
const CCopasiParameterGroupgetScanItem (size_t index) const
 
CTaskEnum::Task getSubtask () const
 
virtual CCopasiTaskgetSubTask () const override
 
void load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)
 
bool removeScanItem (const size_t &index)
 
virtual bool restore (const bool &updateModel) override
 
void setContinueFromCurrentState (bool aic)
 
void setContinueOnError (bool coe)
 
void setOutputInSubtask (bool ois)
 
void setSubtask (CTaskEnum::Task type)
 
 ~CScanProblem ()
 
- Public Member Functions inherited from CCopasiProblem
 CCopasiProblem (const CCopasiProblem &src, const CDataContainer *pParent)
 
virtual void clearCallBack ()
 
CCopasiProblemcopy () const
 
const CProcessReportLevelgetCallBack () const
 
CMathContainergetMathContainer () const
 
const CTaskEnum::TaskgetType () const
 
virtual bool initialize ()
 
virtual void print (std::ostream *ostream) const
 
virtual void printResult (std::ostream *ostream) const
 
virtual bool setCallBack (CProcessReportLevel callBack)
 
void setMathContainer (CMathContainer *pContainer)
 
virtual bool setModel (CModel *model)
 
virtual ~CCopasiProblem ()
 
- Public Member Functions inherited from CCopasiParameterGroup
bool addGroup (const std::string &name)
 
void addParameter (CCopasiParameter *pParameter)
 
bool addParameter (const CCopasiParameter &parameter)
 
bool addParameter (const std::string &name, const CCopasiParameter::Type type, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
 
template<class CType >
bool addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
 
virtual bool applyData (const CData &data, CUndoData::CChangeSet &changes)
 
CCopasiParameterGroupassertGroup (const std::string &name, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
 
template<class CType >
CType * assertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue, const CCopasiParameter::UserInterfaceFlag &flag=CCopasiParameter::UserInterfaceFlag::All)
 
index_iterator beginIndex () const
 
const_name_iterator beginName () const
 
 CCopasiParameterGroup (const CCopasiParameterGroup &src, const CDataContainer *pParent=NULL)
 
 CCopasiParameterGroup (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &objectType="ParameterGroup")
 
void clear ()
 
virtual void createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const
 
virtual bool elevateChildren ()
 
index_iterator endIndex () const
 
const_name_iterator endName () const
 
CCopasiParameterGroupgetElementTemplates ()
 
const CCopasiParameterGroupgetElementTemplates () const
 
CCopasiParameterGroupgetGroup (const size_t &index)
 
const CCopasiParameterGroupgetGroup (const size_t &index) const
 
CCopasiParameterGroupgetGroup (const std::string &name)
 
const CCopasiParameterGroupgetGroup (const std::string &name) const
 
virtual size_t getIndex (const CDataObject *pObject) const
 
size_t getIndex (const std::string &name) const
 
std::string getKey (const size_t &index) const
 
std::string getKey (const std::string &name) const
 
virtual const std::string & getName (const size_t &index) const
 
virtual const CObjectInterfacegetObject (const CCommonName &cn) const
 
CCopasiParametergetParameter (const size_t &index)
 
const CCopasiParametergetParameter (const size_t &index) const
 
CCopasiParametergetParameter (std::string name)
 
const CCopasiParametergetParameter (std::string name) const
 
CCopasiParameter::Type getType (const size_t &index) const
 
CCopasiParameter::Type getType (const std::string &name) const
 
std::string getUniqueParameterName (const CCopasiParameter *pParameter) const
 
template<class CType >
CType & getValue (const size_t &index)
 
template<class CType >
const CType & getValue (const size_t &index) const
 
template<class CType >
CType & getValue (const std::string &name)
 
template<class CType >
const CType & getValue (const std::string &name) const
 
bool haveTemplate () const
 
virtual CUndoObjectInterfaceinsert (const CData &data)
 
CCopasiParameterGroupoperator= (const CCopasiParameterGroup &rhs)
 
virtual bool remove (CDataObject *pObject)
 
bool removeParameter (CCopasiParameter *pParameter)
 
bool removeParameter (const size_t &index)
 
bool removeParameter (const std::string &name)
 
virtual void setUserInterfaceFlag (const UserInterfaceFlag &flag)
 
template<class CType >
bool setValue (const size_t &index, const CType &value)
 
template<class CType >
bool setValue (const std::string &name, const CType &value)
 
size_t size (const UserInterfaceFlag &require=UserInterfaceFlag::None, const UserInterfaceFlag &exclude=UserInterfaceFlag::None) const
 
bool swap (const size_t &iFrom, const size_t &iTo)
 
bool swap (index_iterator &from, index_iterator &to)
 
virtual CData toData () const
 
virtual void updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)
 
virtual ~CCopasiParameterGroup ()
 
- Public Member Functions inherited from CCopasiParameter
 CCopasiParameter (const CCopasiParameter &src, const CDataContainer *pParent)
 
 CCopasiParameter (const std::string &name, const Type &type, const void *pValue=NULL, const CDataContainer *pParent=NO_PARENT, const std::string &objectType="Parameter")
 
virtual CCommonName getCN () const override
 
template<class CType >
const CType & getDefault () const
 
virtual const std::string & getKey () const override
 
virtual std::string getObjectDisplayName () const override
 
const CCopasiParameter::TypegetType () const
 
const UserInterfaceFlaggetUserInterfaceFlag () const
 
template<class CType >
std::vector< std::pair< CType, CType > > & getValidValues ()
 
template<class CType >
const std::vector< std::pair< CType, CType > > & getValidValues () const
 
void * getValidValuesPointer () const
 
template<class CType >
CType & getValue ()
 
template<class CType >
const CType & getValue () const
 
virtual void * getValuePointer () const override
 
CDataObjectgetValueReference () const
 
bool hasValidValues () const
 
bool isBasic () const
 
bool isDefault () const
 
bool isEditable () const
 
bool isUnsupported () const
 
bool isValidValue (const bool &value) const
 
bool isValidValue (const C_FLOAT64 &value) const
 
bool isValidValue (const C_INT32 &value) const
 
bool isValidValue (const CCommonName &value) const
 
template<class CType >
bool isValidValue (const CType &) const
 
bool isValidValue (const std::string &value) const
 
bool isValidValue (const std::vector< CCopasiParameter * > &value) const
 
bool isValidValue (const unsigned C_INT32 &value) const
 
CCopasiParameteroperator= (const CCopasiParameter &rhs)
 
template<class CType >
bool setDefault (const CType &defaultValue)
 
bool setDefault (const std::vector< CCopasiParameter * > &defaultValue)
 
virtual bool setObjectParent (const CDataContainer *pParent) override
 
template<class CType , class Enum >
bool setValidValues (const CEnumAnnotation< CType, Enum > &validValues)
 
template<class CType >
bool setValidValues (const std::vector< std::pair< CType, CType > > &validValues)
 
template<class CType >
bool setValue (const CType &value)
 
bool setValue (const std::vector< CCopasiParameter * > &value)
 
virtual ~CCopasiParameter ()
 
- Public Member Functions inherited from CDataContainer
virtual bool add (CDataObject *pObject, const bool &adopt=true)
 
virtual bool appendDeletedDependentData (CUndoData &undoData) const
 
 CDataContainer (const CDataContainer &src, const CDataContainer *pParent)
 
 CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
 
virtual std::string getChildObjectUnits (const CDataObject *pObject) const
 
void getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const
 
virtual objectMapgetObjects ()
 
virtual const objectMapgetObjects () const
 
virtual const std::string getUnits () const override
 
virtual const CDataObjectgetValueObject () const override
 
void objectRenamed (CDataObject *pObject, const std::string &oldName)
 
virtual ~CDataContainer ()
 
- Public Member Functions inherited from CDataObject
void addIssue (const CIssue &issue)
 
void addReference (const CDataContainer *pReference)
 
virtual void calculateValue () override
 
 CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)
 
virtual void destruct () override
 
virtual const CDataObjectgetDataObject () const override
 
CDataContainergetObjectAncestor (const std::string &type) const
 
CDataModelgetObjectDataModel () const
 
const CObjectInterfacegetObjectFromCN (const CCommonName &cn) const
 
const std::string & getObjectName () const
 
CDataContainergetObjectParent () const
 
const std::string & getObjectType () const
 
virtual const CObjectInterface::ObjectSetgetPrerequisites () const override
 
virtual const CValiditygetValidity () const override
 
bool hasFlag (const Flag &flag) const
 
virtual bool isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const override
 
bool prerequisitsContains (const DataObjectSet &objects) const
 
void removeIssue (const CIssue &issue)
 
void removeReference (const CDataContainer *pReference)
 
bool setObjectName (const std::string &name)
 
void validityChanged (const CValidity &changedValidity) override
 
void validityRemoved (const CValidity &changedValidity)
 
virtual ~CDataObject ()
 
- Public Member Functions inherited from CObjectInterface
 CObjectInterface ()
 
 CObjectInterface (const CObjectInterface &src)
 
virtual ~CObjectInterface ()
 
- Public Member Functions inherited from CUndoObjectInterface
 CUndoObjectInterface ()
 
 CUndoObjectInterface (const CUndoObjectInterface &src)
 
bool generateUuid ()
 
const xg::Guid & getUuid () const
 
bool setUuid (const std::string &uuid)
 
bool setUuid (const xg::Guid &uuid)
 
virtual ~CUndoObjectInterface ()
 

Static Public Member Functions

static CCopasiParameterGroupcreateScanItem (CScanProblem::Type type, size_t steps=5, const CDataObject *obj=NULL)
 
- Static Public Member Functions inherited from CCopasiParameter
static void allocateValidValues (const Type &type, void *&pValidValues)
 
static void allocateValue (const Type &type, void *&pValue)
 
static void assignValue (const Type &type, void *&pValue, const void *pNewValue)
 
static void deleteValidValues (const Type &type, void *&pValidValues)
 
static void deleteValue (const Type &type, void *&pValue)
 
static CCopasiParameterfromData (const CData &data, CUndoObjectInterface *pParent)
 
- Static Public Member Functions inherited from CDataContainer
static CDataContainerfromData (const CData &data, CUndoObjectInterface *pParent)
 
- Static Public Member Functions inherited from CDataObject
static CDataObjectfromData (const CData &data, CUndoObjectInterface *pParent)
 
static void sanitizeObjectName (std::string &name)
 
- Static Public Member Functions inherited from CObjectInterface
static const CDataObjectDataObject (const CObjectInterface *pInterface)
 
static CObjectInterfaceGetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
 
- Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType * fromData (const CData &, CUndoObjectInterface *)
 

Private Member Functions

void initializeParameter ()
 

Private Attributes

CCopasiParameterGroupmpScanItems
 

Additional Inherited Members

- Static Public Attributes inherited from CCopasiParameter
static const CEnumAnnotation< std::string, TypeTypeName
 
static const CEnumAnnotation< std::string, TypeXMLType
 
- Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList EmptyList
 
- Protected Member Functions inherited from CCopasiProblem
 CCopasiProblem (const CCopasiProblem &src)
 
 CCopasiProblem (const CTaskEnum::Task &type, const CDataContainer *pParent)
 
virtual void signalMathContainerChanged ()
 
- Protected Member Functions inherited from CCopasiParameterGroup
 CCopasiParameterGroup ()
 
- Protected Member Functions inherited from CCopasiParameter
 CCopasiParameter (const CCopasiParameter &src)
 
- Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > * addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
 
template<class CType >
CDataObjectReference< CType > * addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
 
template<class CType >
CDataVectorReference< CType > * addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
 
 CDataContainer (const CDataContainer &src)
 
void initObjects ()
 
- Protected Member Functions inherited from CDataObject
 CDataObject ()
 
 CDataObject (const std::string &name, const CDataContainer *pParent=static_cast< CDataContainer * >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
 
- Protected Attributes inherited from CCopasiProblem
CMathContainermpContainer
 
CReportmpReport
 
CProcessReportLevel mProcessReport
 
- Protected Attributes inherited from CCopasiParameter
std::string mKey
 
void * mpDefault
 
void * mpValidValues
 
void * mpValue
 
CDataObjectmpValueReference
 
UserInterfaceFlag mUserInterfaceFlag
 
- Protected Attributes inherited from CDataContainer
objectMap mObjects
 
- Protected Attributes inherited from CDataObject
ObjectSet mPrerequisits
 
std::set< CDataContainer * > mReferences
 
- Protected Attributes inherited from CObjectInterface
CValidity mValidity
 

Detailed Description

CScanProblem class.

Member Enumeration Documentation

◆ Type

Enumerator
SCAN_REPEAT 
SCAN_LINEAR 
SCAN_RANDOM 
SCAN_BREAK 

Constructor & Destructor Documentation

◆ CScanProblem() [1/2]

CScanProblem::CScanProblem ( const CDataContainer pParent = NO_PARENT)

Default constructor.

Parameters
constCDataContainer * pParent (default: NULL)

CScanProblem class. Default constructor.

Parameters
CModel *pModel

References initializeParameter().

◆ CScanProblem() [2/2]

CScanProblem::CScanProblem ( const CScanProblem src,
const CDataContainer pParent 
)

Copy constructor.

Parameters
constCTrajectoryProblem & src @paramconst CDataContainer * pParent (default: NULL)

Copy constructor.

Parameters
const CScanProblem &src

References initializeParameter().

◆ ~CScanProblem()

CScanProblem::~CScanProblem ( )

Destructor.

Member Function Documentation

◆ addScanItem()

CCopasiParameterGroup * CScanProblem::addScanItem ( CScanProblem::Type  type,
size_t  steps = 5,
const CDataObject obj = NULL 
)

◆ clearScanItems()

void CScanProblem::clearScanItems ( )

◆ createScanItem()

◆ fixBuild81()

void CScanProblem::fixBuild81 ( )

Fix files written with Version 4.12.81 and earlier, which wrote the exp(mean) and exp(std. deviation) for normal random distributions in the scan task.

References CCopasiParameterGroup::beginIndex(), C_FLOAT64, C_INT32, CCopasiParameterGroup::endIndex(), CCopasiParameterGroup::getParameter(), CCopasiParameter::getValue(), CCopasiParameter::GROUP, mpScanItems, SCAN_RANDOM, and CCopasiParameter::setValue().

Referenced by CScanTask::fixBuild81().

◆ getContinueFromCurrentState()

bool CScanProblem::getContinueFromCurrentState ( ) const

Retrieve whether the subtask should continue with its last result.

Referenced by CSEDMLExporter::createScanTask(), CScanMethod::init(), CScanTask::initSubtask(), and CScanMethod::isValidProblem().

◆ getContinueOnError()

bool CScanProblem::getContinueOnError ( ) const

Retrieve whether the subtask should continue when an error occurs.

Referenced by CScanMethod::calculate().

◆ getNumberOfScanItems()

size_t CScanProblem::getNumberOfScanItems ( ) const

◆ getOutputInSubtask()

const bool & CScanProblem::getOutputInSubtask ( ) const

Ask if output should be done after every step of the subtask.

◆ getScanItem() [1/2]

◆ getScanItem() [2/2]

◆ getSubtask()

CTaskEnum::Task CScanProblem::getSubtask ( ) const

Get the type of the subtask.

Referenced by COutputAssistant::createPlot(), CSEDMLExporter::createScanTask(), and getSubTask().

◆ getSubTask()

CCopasiTask * CScanProblem::getSubTask ( ) const
overridevirtual

Retrieve the optional sub task

Returns
CCopasiTask* * pSubTask

Reimplemented from CCopasiProblem.

References CDataVector< CType >::begin(), CDataVector< CType >::end(), CDataObject::getObjectDataModel(), getSubtask(), and CDataModel::getTaskList().

Referenced by restore().

◆ initializeParameter()

◆ load()

void CScanProblem::load ( CReadConfig configBuffer,
CReadConfig::Mode  mode = CReadConfig::NEXT 
)

Load a scan problem

Parameters
CReadConfig &configBuffer
"CReadConfig::Modemode (Default: CReadConfig::NEXT)

◆ removeScanItem()

bool CScanProblem::removeScanItem ( const size_t &  index)

◆ restore()

bool CScanProblem::restore ( const bool &  updateModel)
overridevirtual

Do all necessary restore procedures so that the model is in the same state as before

Parameters
constbool & updateModel
Returns
bool success

Reimplemented from CCopasiProblem.

References getSubTask(), and CCopasiTask::restore().

◆ setContinueFromCurrentState()

void CScanProblem::setContinueFromCurrentState ( bool  aic)

Set whether the subtask should continue with its last result.

References CCopasiParameterGroup::setValue().

Referenced by SEDMLImporter::importTask().

◆ setContinueOnError()

void CScanProblem::setContinueOnError ( bool  coe)

Set whether the subtask should continue when error occurs.

References CCopasiParameterGroup::setValue().

◆ setOutputInSubtask()

void CScanProblem::setOutputInSubtask ( bool  ois)

Set if output should be done after every step of the subtask.

References CCopasiParameterGroup::setValue().

Referenced by SEDMLImporter::importTask().

◆ setSubtask()

void CScanProblem::setSubtask ( CTaskEnum::Task  type)

Set the type of the subtask.

References C_INT32, and CCopasiParameterGroup::setValue().

Referenced by SEDMLImporter::importTask().

Member Data Documentation

◆ mpScanItems

CCopasiParameterGroup* CScanProblem::mpScanItems
private

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