CScanMethod Class Reference

#include <CScanMethod.h>

Inheritance diagram for CScanMethod:

Public Member Functions
	CScanMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType=CTaskEnum::Method::scanMethod, const CTaskEnum::Task &taskType=CTaskEnum::Task::scan)
	CScanMethod (const CScanMethod &src, const CDataContainer *pParent)
size_t	getTotalNumberOfSteps () const
bool	init ()
virtual bool	isValidProblem (const CCopasiProblem *pProblem)
bool	scan ()
void	setProblem (CScanProblem *problem)
	~CScanMethod ()
Public Member Functions inherited from CCopasiMethod
	CCopasiMethod (const CCopasiMethod &src, const CDataContainer *pParent)
virtual void	clearCallBack ()
const CProcessReportLevel &	getCallBack () const
CMathContainer *	getMathContainer () const
const CTaskEnum::Method &	getSubType () const
const CTaskEnum::Task &	getType () const
virtual void	load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::SEARCH)
CCopasiMethod &	operator= (const CCopasiMethod &rhs)
virtual void	print (std::ostream *ostream) const
virtual void	printResult (std::ostream *ostream) const
virtual bool	setCallBack (CProcessReportLevel callBack)
void	setMathContainer (CMathContainer *pContainer)
virtual	~CCopasiMethod ()
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)
CCopasiParameterGroup *	assertGroup (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
CCopasiParameterGroup &	getElementTemplates ()
const CCopasiParameterGroup &	getElementTemplates () const
CCopasiParameterGroup *	getGroup (const size_t &index)
const CCopasiParameterGroup *	getGroup (const size_t &index) const
CCopasiParameterGroup *	getGroup (const std::string &name)
const CCopasiParameterGroup *	getGroup (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 CObjectInterface *	getObject (const CCommonName &cn) const
CCopasiParameter *	getParameter (const size_t &index)
const CCopasiParameter *	getParameter (const size_t &index) const
CCopasiParameter *	getParameter (std::string name)
const CCopasiParameter *	getParameter (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 CUndoObjectInterface *	insert (const CData &data)
CCopasiParameterGroup &	operator= (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::Type &	getType () const
const UserInterfaceFlag &	getUserInterfaceFlag () 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
CDataObject *	getValueReference () 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
CCopasiParameter &	operator= (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 objectMap &	getObjects ()
virtual const objectMap &	getObjects () const
virtual const std::string	getUnits () const override
virtual const CDataObject *	getValueObject () 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 CDataObject *	getDataObject () const override
CDataContainer *	getObjectAncestor (const std::string &type) const
CDataModel *	getObjectDataModel () const
const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const
const std::string &	getObjectName () const
CDataContainer *	getObjectParent () const
const std::string &	getObjectType () const
virtual const CObjectInterface::ObjectSet &	getPrerequisites () const override
virtual const CValidity &	getValidity () 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 ()

Protected Attributes
bool	mContinueFromCurrentState
size_t	mFailCounter
CCore::CUpdateSequence	mInitialUpdates
size_t	mLastNestingItem
CScanProblem *	mpProblem
CRandom *	mpRandomGenerator
CScanTask *	mpTask
std::vector< CScanItem * >	mScanItems
size_t	mTotalSteps
Protected Attributes inherited from CCopasiMethod
CMathContainer *	mpContainer
CProcessReportLevel	mProcessReport
Protected Attributes inherited from CCopasiParameter
std::string	mKey
void *	mpDefault
void *	mpValidValues
void *	mpValue
CDataObject *	mpValueReference
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

Private Member Functions
bool	calculate ()
bool	cleanupScanItems ()
	CScanMethod ()
bool	loop (size_t level)

Additional Inherited Members
Public Types inherited from CCopasiParameterGroup
typedef CDataObjectMap::const_type_iterator< CCopasiParameter >	const_name_iterator
typedef std::vector< CCopasiParameter * >	elements
typedef elements::iterator	index_iterator
typedef CDataObjectMap::type_iterator< CCopasiParameter >	name_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< eUserInterfaceFlag >	UserInterfaceFlag
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
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 CCopasiParameter *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)
static void	sanitizeObjectName (std::string &name)
Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)
static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)
Static Public Attributes inherited from CCopasiParameter
static const CEnumAnnotation< std::string, Type >	TypeName
static const CEnumAnnotation< std::string, Type >	XMLType
Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList
Protected Member Functions inherited from CCopasiMethod
	CCopasiMethod (const CCopasiMethod &src)
	CCopasiMethod (const CDataContainer *pParent, const CTaskEnum::Method &methodType, const CTaskEnum::Task &taskType)
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)

Constructor & Destructor Documentation

CScanMethod() [1/3]

CScanMethod::CScanMethod ( )

private

Default constructor

CScanMethod() [2/3]

CScanMethod::CScanMethod	(	const CDataContainer *	pParent,
		const CTaskEnum::Method &	methodType = CTaskEnum::Method::scanMethod,
		const CTaskEnum::Task &	taskType = CTaskEnum::Task::scan
	)

Specific constructor

Parameters

const	CDataContainer * pParent
const	CTaskEnum::Method & methodType (default: scanMethod)
const	CTaskEnum::Task & taskType (default: scan)

References CRandom::createGenerator(), and mpRandomGenerator.

CScanMethod() [3/3]

CScanMethod::CScanMethod	(	const CScanMethod &	src,
		const CDataContainer *	pParent
	)

Copy constructor

Parameters

const	CScanMethod & src
const	CDataContainer * pParent

References CRandom::createGenerator(), and mpRandomGenerator.

~CScanMethod()

CScanMethod::~CScanMethod

(

)

Destructor.

References cleanupScanItems(), and mpRandomGenerator.

Member Function Documentation

calculate()

bool CScanMethod::calculate ( void  )

private

References CMathContainer::applyUpdateSequence(), CScanProblem::getContinueOnError(), CMathContainer::getInitialState(), CCopasiMessage::getLastMessage(), CMathContainer::getValues(), mFailCounter, mInitialUpdates, CCopasiMethod::mpContainer, mpProblem, mpTask, CScanTask::processCallback(), and CMathContainer::setInitialState().

Referenced by loop(), and scan().

cleanupScanItems()

bool CScanMethod::cleanupScanItems ( )

private

References mpProblem, and mScanItems.

Referenced by init(), and ~CScanMethod().

getTotalNumberOfSteps()

size_t CScanMethod::getTotalNumberOfSteps ( ) const

inline

References mTotalSteps.

Referenced by CScanTask::process().

init()

bool CScanMethod::init

(

)

References CVectorCore< CType >::begin(), C_INVALID_INDEX, cleanupScanItems(), CMathUpdateSequence::clear(), CScanItem::createScanItemFromParameterGroup(), CScanProblem::getContinueFromCurrentState(), CObjectInterface::getDataObject(), CMathContainer::getInitialDependencies(), CMathContainer::getInitialState(), CMathContainer::getInitialStateObjects(), CScanProblem::getNumberOfScanItems(), CScanItem::getNumSteps(), CScanItem::getObject(), CDataObject::getObjectParent(), CScanProblem::getScanItem(), CMathContainer::getSimulationUpToDateObjects(), CMathContainer::getState(), CMathContainer::getTransientDependencies(), CMathDependencyGraph::getUpdateSequence(), CMath::LocalReactionParameter, mContinueFromCurrentState, mInitialUpdates, mLastNestingItem, CCopasiMethod::mpContainer, mpProblem, mpRandomGenerator, mpTask, mScanItems, mTotalSteps, and CCore::UpdateMoieties.

Referenced by CScanTask::process().

isValidProblem()

bool CScanMethod::isValidProblem ( const CCopasiProblem *  pProblem )

virtual

The main scan method. Check if the method is suitable for this problem

Returns

bool suitability of the method

Reimplemented from CCopasiMethod.

References CScanItem::createScanItemFromParameterGroup(), CCopasiMessage::ERROR, CCopasiMessage::EXCEPTION, CScanProblem::getContinueFromCurrentState(), CScanProblem::getNumberOfScanItems(), CScanProblem::getScanItem(), CCopasiMethod::isValidProblem(), CScanItem::isValidScanItem(), mContinueFromCurrentState, mpProblem, mpRandomGenerator, and CCopasiMessage::WARNING.

loop()

bool CScanMethod::loop ( size_t  level )

private

References calculate(), CDataObject::getObjectParent(), CScanItem::isFinished(), CScanItem::isNesting(), mLastNestingItem, mScanItems, CScanItem::reset(), and CScanItem::step().

Referenced by scan().

scan()

bool CScanMethod::scan

(

)

References calculate(), CCopasiMessage::ERROR, loop(), mFailCounter, mpProblem, and mScanItems.

Referenced by CScanTask::process().

setProblem()

void CScanMethod::setProblem

(

CScanProblem *

problem

)

Set a pointer to the problem. This method is used by CTrajectory

Parameters

CTrajectoryProblem *

problem

References mpProblem.

Referenced by CScanTask::process().

Member Data Documentation

mContinueFromCurrentState

bool CScanMethod::mContinueFromCurrentState

protected

Variable indicating whether the subtask shall continue from the current state or the initial state

Referenced by init(), and isValidProblem().

mFailCounter

size_t CScanMethod::mFailCounter

protected

Count exceptions thrown by subtask

Referenced by calculate(), and scan().

mInitialUpdates

CCore::CUpdateSequence CScanMethod::mInitialUpdates

protected

Referenced by calculate(), and init().

mLastNestingItem

size_t CScanMethod::mLastNestingItem

protected

the index of the last item that has several subitems, also the last item that need to generate output separators

Referenced by init(), and loop().

mpProblem

CScanProblem* CScanMethod::mpProblem

protected

A pointer to the trajectory problem.

Referenced by calculate(), cleanupScanItems(), init(), isValidProblem(), scan(), and setProblem().

mpRandomGenerator

CRandom* CScanMethod::mpRandomGenerator

protected

A pointer to the random number generator

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

mpTask

CScanTask* CScanMethod::mpTask

protected

A pointer to the scan Task.

Referenced by calculate(), and init().

mScanItems

std::vector<CScanItem*> CScanMethod::mScanItems

protected

Referenced by cleanupScanItems(), init(), loop(), and scan().

mTotalSteps

size_t CScanMethod::mTotalSteps

protected

Referenced by getTotalNumberOfSteps(), and init().

---

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

• CScanMethod.h
• CScanMethod.cpp