#include <CTSSAProblem.h>

Inheritance diagram for CTSSAProblem:

Public Member Functions
	CTSSAProblem (const CDataContainer *pParent=NO_PARENT)

	CTSSAProblem (const CTSSAProblem &src, const CDataContainer *pParent)

virtual bool	elevateChildren ()

const C_FLOAT64 &	getDuration () const

const C_FLOAT64 &	getOutputStartTime () const

const unsigned C_INT32 &	getStepNumber () const

const C_FLOAT64 &	getStepSize () const

void	setDuration (const C_FLOAT64 &duration)

void	setOutputStartTime (const C_FLOAT64 &endTime)

void	setStepNumber (const unsigned C_INT32 &stepNumber)

void	setStepSize (const C_FLOAT64 &stepSize)

void	setTimeSeriesRequested (bool flag)

bool	timeSeriesRequested () const

	~CTSSAProblem ()

Public Member Functions inherited from CCopasiProblem
	CCopasiProblem (const CCopasiProblem &src, const CDataContainer *pParent)

virtual void	clearCallBack ()

CCopasiProblem *	copy () const

const CProcessReportLevel &	getCallBack () const

CMathContainer *	getMathContainer () const

virtual CCopasiTask *	getSubTask () const

const CTaskEnum::Task &	getType () const

virtual bool	initialize ()

virtual void	print (std::ostream *ostream) const

virtual bool	restore (const bool &updateModel)

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)

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

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 Member Functions
	CTSSAProblem (const CTSSAProblem &src)

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)

Private Member Functions
void	initializeParameter ()

void	initObjects ()

void	printResult (std::ostream *ostream) const

bool	sync ()

Private Attributes
C_FLOAT64 *	mpDuration

C_FLOAT64 *	mpOutputStartTime

unsigned C_INT32 *	mpStepNumber

C_FLOAT64 *	mpStepSize

bool *	mpTimeSeriesRequested

bool	mStepNumberSetLast

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 Attributes inherited from CCopasiProblem
CMathContainer *	mpContainer

CReport *	mpReport

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

Detailed Description

CTSSAProblem class. This class describes the time scale separation analysis problem, i.e., it allows to specify for example initial conditions and number of steps.

Constructor & Destructor Documentation

◆ CTSSAProblem() [1/3]

CTSSAProblem::CTSSAProblem ( const CTSSAProblem & src )

protected

◆ CTSSAProblem() [2/3]

CTSSAProblem::CTSSAProblem ( const CDataContainer * pParent = NO_PARENT )

Default constructor.

Parameters

const CDataContainer * pParent (default: NULL)

CTSSAProblem class. This class describes the time scale separation analysis problem, i.e., it allows to specify for example initial conditions and number of steps. Default constructor.

References CONSTRUCTOR_TRACE, initializeParameter(), and initObjects().

◆ CTSSAProblem() [3/3]

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

Copy constructor.

Parameters

const CTSSAProblem & src @paramconst CDataContainer * pParent (default: NULL)

Copy constructor.

Parameters

const CTSSAProblem & src

References CONSTRUCTOR_TRACE, initializeParameter(), and initObjects().

◆ ~CTSSAProblem()

CTSSAProblem::~CTSSAProblem ( )

Destructor.

References DESTRUCTOR_TRACE.

Member Function Documentation

◆ elevateChildren()

bool CTSSAProblem::elevateChildren ( )

virtual

This methods must be called to elevate subgroups to derived objects. The default implementation does nothing.

Returns: bool success

Reimplemented from CCopasiParameterGroup.

References C_FLOAT64, mpDuration, mpStepNumber, mpStepSize, CCopasiParameterGroup::removeParameter(), and setDuration().

◆ getDuration()

const C_FLOAT64 & CTSSAProblem::getDuration ( ) const

Retrieve the end time.

Returns: "const C_FLOAT64 &" duration

References mpDuration.

Referenced by CTSSATask::process().

◆ getOutputStartTime()

const C_FLOAT64 & CTSSAProblem::getOutputStartTime ( ) const

Retrieve the end time.

Returns: "const C_FLOAT64 &" endTime

References mpOutputStartTime.

Referenced by CTSSATask::process().

◆ getStepNumber()

const unsigned C_INT32 & CTSSAProblem::getStepNumber ( ) const

Retrieve the number of time steps the method should integrate.

Returns: "const unsigned C_INT32 &" stepNumber

Retrieve the number of time steps the trajectory method should integrate.

Returns: "const unsigned C_INT32 &" stepNumber

References mpStepNumber.

Referenced by CTSSATask::initialize().

◆ getStepSize()

const C_FLOAT64 & CTSSAProblem::getStepSize ( ) const

Retrieve the size a integration step the method should do.

Returns: "const C_FLOAT64 &" stepSize

Retrieve the size a integration step the trajectory method should do.

Returns: "const C_FLOAT64 &" stepSize

References mpStepSize.

Referenced by CTSSATask::process().

◆ initializeParameter()

void CTSSAProblem::initializeParameter ( )

private

Intialize the method parameter

References CCopasiParameterGroup::assertParameter(), CCopasiParameter::BOOL, C_FLOAT64, C_INT32, CCopasiParameter::DOUBLE, mpDuration, mpOutputStartTime, mpStepNumber, mpStepSize, mpTimeSeriesRequested, and CCopasiParameter::UINT.

Referenced by CTSSAProblem().

◆ initObjects()

void CTSSAProblem::initObjects ( )

private

Referenced by CTSSAProblem().

◆ printResult()

void CTSSAProblem::printResult ( std::ostream * ostream ) const

privatevirtual

This is the output method for any result of a problem. The default implementation provided with CCopasiProblem. Does only print "Not implemented." To override this default behavior one needs to re-implement the virtual printResult function.

Parameters

std::ostream * ostream

Reimplemented from CCopasiProblem.

References CCopasiTask::getMethod(), CDataObject::getObjectDataModel(), CCopasiProblem::print(), and CCopasiMethod::printResult().

◆ setDuration()

void CTSSAProblem::setDuration ( const C_FLOAT64 & duration )

Set the end time.

Parameters

const C_FLOAT64 & duration @parem bool success

References mpDuration, and sync().

Referenced by elevateChildren().

◆ setOutputStartTime()

void CTSSAProblem::setOutputStartTime ( const C_FLOAT64 & endTime )

Set the end time.

Parameters

const C_FLOAT64 & endTime

References mpOutputStartTime.

◆ setStepNumber()

void CTSSAProblem::setStepNumber ( const unsigned C_INT32 & stepNumber )

Set the number of time steps the method should integrate.

Parameters

const unsigned C_INT32 & stepNumber @parem bool success

Set the number of time steps the trajectory method should integrate.

Parameters

const unsigned C_INT32 & stepNumber

References mpStepNumber, mStepNumberSetLast, and sync().

◆ setStepSize()

void CTSSAProblem::setStepSize ( const C_FLOAT64 & stepSize )

Set the size a integration step the method should do.

Parameters

const C_FLOAT64 & stepSize @parem bool success

Set the size a integration step the trajectory method should do.

Parameters

const C_FLOAT64 & stepSize

References mpStepSize, mStepNumberSetLast, and sync().

◆ setTimeSeriesRequested()

void CTSSAProblem::setTimeSeriesRequested ( bool flag )

References mpTimeSeriesRequested.

◆ sync()

bool CTSSAProblem::sync ( )

private

This function synchronizes step size and number @parem bool success

This function synchronizes step size and number

References C_FLOAT64, C_INT32, MCTSSAProblem, mpDuration, mpStepNumber, mpStepSize, mStepNumberSetLast, and CCopasiMessage::WARNING.

Referenced by setDuration(), setStepNumber(), and setStepSize().

◆ timeSeriesRequested()

bool CTSSAProblem::timeSeriesRequested ( ) const

References mpTimeSeriesRequested.

Referenced by CTSSATask::initialize().

Member Data Documentation

◆ mpDuration

C_FLOAT64* CTSSAProblem::mpDuration

private

Referenced by elevateChildren(), getDuration(), initializeParameter(), setDuration(), and sync().

◆ mpOutputStartTime

C_FLOAT64* CTSSAProblem::mpOutputStartTime

private

Referenced by getOutputStartTime(), initializeParameter(), and setOutputStartTime().

◆ mpStepNumber

unsigned C_INT32* CTSSAProblem::mpStepNumber

private

Referenced by elevateChildren(), getStepNumber(), initializeParameter(), setStepNumber(), and sync().

◆ mpStepSize

C_FLOAT64* CTSSAProblem::mpStepSize

private

Referenced by elevateChildren(), getStepSize(), initializeParameter(), setStepSize(), and sync().

◆ mpTimeSeriesRequested

bool* CTSSAProblem::mpTimeSeriesRequested

private

Referenced by initializeParameter(), setTimeSeriesRequested(), and timeSeriesRequested().

◆ mStepNumberSetLast

bool CTSSAProblem::mStepNumberSetLast

private

Indicate whether the step number or step size was set last.

Referenced by setStepNumber(), setStepSize(), and sync().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CTSSAProblem() [1/3]

◆ CTSSAProblem() [2/3]

◆ CTSSAProblem() [3/3]

◆ ~CTSSAProblem()

Member Function Documentation

◆ elevateChildren()

◆ getDuration()

◆ getOutputStartTime()

◆ getStepNumber()

◆ getStepSize()

◆ initializeParameter()

◆ initObjects()

◆ printResult()

◆ setDuration()

◆ setOutputStartTime()

◆ setStepNumber()

◆ setStepSize()

◆ setTimeSeriesRequested()

◆ sync()

◆ timeSeriesRequested()

Member Data Documentation

◆ mpDuration

◆ mpOutputStartTime

◆ mpStepNumber

◆ mpStepSize

◆ mpTimeSeriesRequested

◆ mStepNumberSetLast