CCrossSectionProblem Class Reference

#include <CCrossSectionProblem.h>

Inheritance diagram for CCrossSectionProblem:

Collaboration diagram for CCrossSectionProblem:

Public Member Functions
	CCrossSectionProblem (const CCopasiContainer *pParent=NULL)
	CCrossSectionProblem (const CCrossSectionProblem &src, const CCopasiContainer *pParent=NULL)
const C_FLOAT64 &	getConvergenceOutTolerance () const
const C_FLOAT64 &	getConvergenceTolerance () const
const unsigned C_INT32 &	getCrossingsLimit () const
bool	getFlagLimitConvergence () const
bool	getFlagLimitCrossings () const
bool	getFlagLimitOutConvergence () const
bool	getFlagLimitOutCrossings () const
bool	getFlagLimitOutTime () const
const unsigned C_INT32 &	getOutCrossingsLimit () const
const std::string &	getSingleObjectCN () const
const C_FLOAT64 &	getThreshold () const
const C_FLOAT64 &	getTimeLimit () const
bool	isPositiveDirection () const
virtual void	print (std::ostream *ostream) const
void	setConvergenceOutTolerance (const C_FLOAT64 &convergenceTolerance)
void	setConvergenceTolerance (const C_FLOAT64 &convergenceTolerance)
void	setCrossingsLimit (const unsigned C_INT32 &crossingLimit)
void	setFlagLimitConvergence (bool flagLimitConvergence)
void	setFlagLimitCrossings (bool flagLimitCrossing)
void	setFlagLimitOutConvergence (bool flagLimitConvergence)
void	setFlagLimitOutCrossings (bool flagLimitCrossing)
void	setFlagLimitOutTime (bool flagLimitTime)
void	setOutCrossingsLimit (const unsigned C_INT32 &crossingLimit)
void	setPositiveDirection (bool isPositive)
void	setSingleObjectCN (const std::string &cn)
void	setSingleObjectCN (const CCopasiObject *pObject)
void	setThreshold (const C_FLOAT64 &threshold)
void	setTimeLimit (const C_FLOAT64 &timeLimit)
virtual	~CCrossSectionProblem ()
Public Member Functions inherited from CTrajectoryProblem
	CTrajectoryProblem (const CCopasiContainer *pParent=NULL)
	CTrajectoryProblem (const CTrajectoryProblem &src, const CCopasiContainer *pParent=NULL)
virtual bool	elevateChildren ()
const bool &	getContinueSimultaneousEvents () const
const C_FLOAT64 &	getDuration () const
const bool &	getOutputEvent () const
const C_FLOAT64 &	getOutputStartTime () const
const unsigned C_INT32 &	getStepNumber () const
const C_FLOAT64 &	getStepSize () const
void	load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::NEXT)
void	setContinueSimultaneousEvents (const bool &continueSimultaneousEvents)
void	setDuration (const C_FLOAT64 &duration)
void	setOutputEvent (const bool &outputEvent)
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
	~CTrajectoryProblem ()
Public Member Functions inherited from CCopasiProblem
	CCopasiProblem (const CCopasiProblem &src, const CCopasiContainer *pParent=NULL)
CModel *	getModel () const
const CCopasiTask::Type &	getType () const
virtual bool	initialize ()
virtual void	printResult (std::ostream *ostream) const
virtual bool	restore (const bool &updateModel)
virtual bool	setCallBack (CProcessReport *pCallBack)
virtual bool	setModel (CModel *pModel)
virtual	~CCopasiProblem ()
Public Member Functions inherited from CCopasiParameterGroup
bool	addGroup (const std::string &name)
bool	addParameter (const CCopasiParameter &parameter)
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 ()
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 ()
Public Member Functions inherited from CCopasiParameter
	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 ()
Public Member Functions inherited from CCopasiContainer
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 ()
Public Member Functions inherited from CCopasiObject
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 ()
Public Member Functions inherited from CObjectInterface
	CObjectInterface ()
virtual	~CObjectInterface ()

Private Member Functions
unsigned C_INT32	getStepNumber () const
C_FLOAT64	getStepSize () const
void	initializeParameter ()
void	initObjects ()

Private Attributes
C_FLOAT64 *	mpConvergenceOutTolerance
C_FLOAT64 *	mpConvergenceTolerance
unsigned C_INT32 *	mpCrossingsLimit
bool *	mpFlagLimitConvergence
bool *	mpFlagLimitCrossings
bool *	mpFlagLimitOutConvergence
bool *	mpFlagLimitOutCrossings
bool *	mpFlagLimitOutTime
bool *	mpFlagPositiveDirection
unsigned C_INT32 *	mpOutCrossingsLimit
C_FLOAT64 *	mpThreshold
std::string *	mpTriggerExpression
std::string *	mSingleObjectCN

Friends
std::ostream &	operator<< (std::ostream &os, const CCrossSectionProblem &o)

Additional Inherited Members
Public Types inherited from CCopasiParameterGroup
typedef parameterGroup::iterator	index_iterator
typedef CCopasiContainer::objectMap::iterator	name_iterator
typedef std::vector < CCopasiParameter * >	parameterGroup
Public Types inherited from CCopasiParameter
enum	Type {   DOUBLE = 0, UDOUBLE, INT, UINT,   BOOL, GROUP, STRING, CN,   KEY, FILE, EXPRESSION, INVALID }
Public Types inherited from CCopasiContainer
typedef std::multimap < std::string, CCopasiObject * >	objectMap
Public Types inherited from CCopasiObject
typedef std::set< const CCopasiObject * >	DataObjectSet
typedef std::vector< Refresh * >	DataUpdateSequence
Public Types inherited from CObjectInterface
typedef std::set< const CObjectInterface * >	ObjectSet
typedef std::vector < CObjectInterface * >	UpdateSequence
Static Public Member Functions inherited from CCopasiObject
static std::vector< Refresh * >	buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet())
static void	setRenameHandler (CRenameHandler *rh)
Static Public Attributes inherited from CCopasiParameter
static const std::string	TypeName []
static const char *	XMLType []
Static Public Attributes inherited from CCopasiContainer
static const std::vector < CCopasiContainer * >	EmptyList
Protected Types inherited from CCopasiObject
enum	Flag {   Container = 0x1, Vector = 0x2, Matrix = 0x4, NameVector = 0x8,   Reference = 0x10, ValueBool = 0x20, ValueInt = 0x40, ValueInt64 = 0x80,   ValueDbl = 0x100, NonUniqueName = 0x200, StaticString = 0x400, ValueString = 0x800,   Separator = 0x1000, ModelEntity = 0x2000, Array = 0x4000, DataModel = 0x8000,   Root = 0x10000, Gui = 0x20000 }
Protected Member Functions inherited from CCopasiProblem
	CCopasiProblem (const CCopasiTask::Type &type, const CCopasiContainer *pParent=NULL)
Protected Member Functions inherited from CCopasiParameterGroup
	CCopasiParameterGroup ()
Protected Member Functions inherited from CCopasiContainer
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 ()
Protected Member Functions inherited from CCopasiObject
	CCopasiObject ()
	CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0)
Protected Attributes inherited from CTrajectoryProblem
bool *	mpContinueSimultaneousEvents
C_FLOAT64 *	mpDuration
bool *	mpOutputEvent
C_FLOAT64 *	mpOutputStartTime
unsigned C_INT32 *	mpStepNumber
C_FLOAT64 *	mpStepSize
bool *	mpTimeSeriesRequested
bool	mStepNumberSetLast
Protected Attributes inherited from CCopasiProblem
CProcessReport *	mpCallBack
CModel *	mpModel
CReport *	mpReport
Protected Attributes inherited from CCopasiParameter
std::string	mKey
CCopasiObject *	mpValueReference
size_t	mSize
Value	mValue
Protected Attributes inherited from CCopasiContainer
objectMap	mObjects
Static Protected Attributes inherited from CCopasiObject
static CRenameHandler *	smpRenameHandler = NULL

Detailed Description

Definition at line 11 of file CCrossSectionProblem.h.

Constructor & Destructor Documentation

CCrossSectionProblem::CCrossSectionProblem

(

const CCopasiContainer *

pParent = NULL

)

Default constructor.

Parameters

const

CCopasiContainer * pParent (default: NULL)

Definition at line 9 of file CCrossSectionProblem.cpp.

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

                                                                          :
  CTrajectoryProblem(pParent),
  mpFlagLimitCrossings(NULL),
  mpCrossingsLimit(NULL),
  mpFlagLimitConvergence(NULL),
  mpConvergenceTolerance(NULL),
  mpFlagLimitOutConvergence(NULL),
  mpConvergenceOutTolerance(NULL),
  mpFlagLimitOutCrossings(NULL),
  mpOutCrossingsLimit(NULL),
  mpFlagLimitOutTime(NULL),
  mSingleObjectCN(NULL),
  mpFlagPositiveDirection(NULL),
  mpThreshold(NULL)
{
  initializeParameter();
  initObjects();
  CONSTRUCTOR_TRACE;
}

CCrossSectionProblem::CCrossSectionProblem	(	const CCrossSectionProblem &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor.

Parameters

const CCrossSectionProblem &

src CCopasiContainer * pParent (default: NULL)

Definition at line 29 of file CCrossSectionProblem.cpp.

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

                                     :
  CTrajectoryProblem(src, pParent),
  mpFlagLimitCrossings(NULL),
  mpCrossingsLimit(NULL),
  mpFlagLimitConvergence(NULL),
  mpConvergenceTolerance(NULL),
  mpFlagLimitOutConvergence(NULL),
  mpConvergenceOutTolerance(NULL),
  mpFlagLimitOutCrossings(NULL),
  mpOutCrossingsLimit(NULL),
  mpFlagLimitOutTime(NULL),
  mSingleObjectCN(NULL),
  mpFlagPositiveDirection(NULL),
  mpThreshold(NULL)
{
  initializeParameter();
  initObjects();
  CONSTRUCTOR_TRACE;
}

CCrossSectionProblem::~CCrossSectionProblem ( )

virtual

Destructor.

Definition at line 76 of file CCrossSectionProblem.cpp.

References DESTRUCTOR_TRACE.

{DESTRUCTOR_TRACE;}

Member Function Documentation

const C_FLOAT64 & CCrossSectionProblem::getConvergenceOutTolerance

(

)

const

Function to get mpConvergenceOutTolerance

Definition at line 193 of file CCrossSectionProblem.cpp.

References mpConvergenceOutTolerance.

Referenced by CQCrossSectionTaskWidget::loadTask(), and CQCrossSectionTaskWidget::updateValues().

{
  return *mpConvergenceOutTolerance;
}

const C_FLOAT64 & CCrossSectionProblem::getConvergenceTolerance

(

)

const

Function to get mpConvergenceTolerance

Definition at line 173 of file CCrossSectionProblem.cpp.

References mpConvergenceTolerance.

Referenced by CQCrossSectionTaskWidget::loadTask(), and CQCrossSectionTaskWidget::updateValues().

{
  return *mpConvergenceTolerance;
}

const unsigned C_INT32 & CCrossSectionProblem::getCrossingsLimit

(

)

const

Function to get mpCrossingsLimit

Definition at line 94 of file CCrossSectionProblem.cpp.

References mpCrossingsLimit.

Referenced by CQCrossSectionTaskWidget::loadTask(), CCrossSectionTask::process(), and CQCrossSectionTaskWidget::updateValues().

{return *mpCrossingsLimit;}

bool CCrossSectionProblem::getFlagLimitConvergence

(

)

const

Function to get mpFlagLimitConvergence

Definition at line 168 of file CCrossSectionProblem.cpp.

References mpFlagLimitConvergence.

Referenced by CCrossSectionTask::eventCallBack(), and CQCrossSectionTaskWidget::loadTask().

{
  return *mpFlagLimitConvergence;
}

bool CCrossSectionProblem::getFlagLimitCrossings

(

)

const

Function to get mpFlagLimitCrossings

Definition at line 91 of file CCrossSectionProblem.cpp.

References mpFlagLimitCrossings.

Referenced by CQCrossSectionTaskWidget::loadTask(), and CCrossSectionTask::process().

{return *mpFlagLimitCrossings;}

bool CCrossSectionProblem::getFlagLimitOutConvergence

(

)

const

Function to get mpFlagLimitOutConvergence

Definition at line 188 of file CCrossSectionProblem.cpp.

References mpFlagLimitOutConvergence.

Referenced by CCrossSectionTask::eventCallBack(), and CQCrossSectionTaskWidget::loadTask().

{
  return *mpFlagLimitOutConvergence;
}

bool CCrossSectionProblem::getFlagLimitOutCrossings

(

)

const

Function to get mpFlagLimitOutCrossings

Definition at line 97 of file CCrossSectionProblem.cpp.

References mpFlagLimitOutCrossings.

Referenced by CCrossSectionTask::eventCallBack(), CQCrossSectionTaskWidget::loadTask(), and CCrossSectionTask::process().

{return *mpFlagLimitOutCrossings;}

bool CCrossSectionProblem::getFlagLimitOutTime

(

)

const

Function to get mpFlagLimitOutTime

Definition at line 103 of file CCrossSectionProblem.cpp.

References mpFlagLimitOutTime.

Referenced by CCrossSectionTask::eventCallBack(), CQCrossSectionTaskWidget::loadTask(), and CCrossSectionTask::process().

{return *mpFlagLimitOutTime;}

const unsigned C_INT32 & CCrossSectionProblem::getOutCrossingsLimit

(

)

const

Function to get mpOutCrossingsLimit

Definition at line 100 of file CCrossSectionProblem.cpp.

References mpOutCrossingsLimit.

Referenced by CQCrossSectionTaskWidget::loadTask(), CCrossSectionTask::process(), and CQCrossSectionTaskWidget::updateValues().

{return *mpOutCrossingsLimit;}

const std::string & CCrossSectionProblem::getSingleObjectCN

(

)

const

return the variable

Definition at line 139 of file CCrossSectionProblem.cpp.

References mSingleObjectCN.

Referenced by CCrossSectionTask::createEvent(), and CQCrossSectionTaskWidget::loadTask().

{
  return *mSingleObjectCN;
}

unsigned C_INT32 CCrossSectionProblem::getStepNumber ( ) const

inlineprivate

Definition at line 174 of file CCrossSectionProblem.h.

{return 0;}

C_FLOAT64 CCrossSectionProblem::getStepSize ( ) const

inlineprivate

Definition at line 175 of file CCrossSectionProblem.h.

{return 0.0;}

const C_FLOAT64 & CCrossSectionProblem::getThreshold

(

)

const

Definition at line 151 of file CCrossSectionProblem.cpp.

References mpThreshold.

Referenced by CCrossSectionTask::createEvent(), CQCrossSectionTaskWidget::loadTask(), and CQCrossSectionTaskWidget::updateValues().

{
  return *mpThreshold;
}

const C_FLOAT64 & CCrossSectionProblem::getTimeLimit

(

)

const

Function to get mpTimeLimit

Definition at line 106 of file CCrossSectionProblem.cpp.

References CTrajectoryProblem::mpDuration.

Referenced by CQCrossSectionTaskWidget::loadTask(), and CQCrossSectionTaskWidget::updateValues().

{return *mpDuration;}

void CCrossSectionProblem::initializeParameter ( )

private

Initialize the parameters

Definition at line 50 of file CCrossSectionProblem.cpp.

References CCopasiParameterGroup::assertParameter(), CCopasiParameter::BOOL, C_FLOAT64, C_INT32, CCopasiParameter::CN, CCopasiParameter::DOUBLE, CCopasiParameter::EXPRESSION, CCopasiParameter::getValue(), mpConvergenceOutTolerance, mpConvergenceTolerance, mpCrossingsLimit, mpFlagLimitConvergence, mpFlagLimitCrossings, mpFlagLimitOutConvergence, mpFlagLimitOutCrossings, mpFlagLimitOutTime, mpFlagPositiveDirection, mpOutCrossingsLimit, mpThreshold, mpTriggerExpression, mSingleObjectCN, CCopasiParameter::Value::pBOOL, CCopasiParameter::Value::pCN, CCopasiParameter::Value::pDOUBLE, CCopasiParameter::Value::pEXPRESSION, CCopasiParameter::Value::pUINT, and CCopasiParameter::UINT.

Referenced by CCrossSectionProblem().

{
  mpFlagLimitCrossings  = assertParameter("LimitCrossings", CCopasiParameter::BOOL, false)->getValue().pBOOL;
  mpCrossingsLimit  = assertParameter("NumCrossingsLimit", CCopasiParameter::UINT, (unsigned C_INT32)0)->getValue().pUINT;
  mpFlagLimitOutTime  = assertParameter("LimitOutTime", CCopasiParameter::BOOL, false)->getValue().pBOOL;
  mpFlagLimitOutCrossings  = assertParameter("LimitOutCrossings", CCopasiParameter::BOOL, false)->getValue().pBOOL;
  mpFlagPositiveDirection  = assertParameter("PositiveDirection", CCopasiParameter::BOOL, true)->getValue().pBOOL;
  mpOutCrossingsLimit  = assertParameter("NumOutCrossingsLimit", CCopasiParameter::UINT, (unsigned C_INT32)0)->getValue().pUINT;
  mpFlagLimitConvergence  = assertParameter("LimitUntilConvergence", CCopasiParameter::BOOL, false)->getValue().pBOOL;
  mpConvergenceTolerance  = assertParameter("ConvergenceTolerance", CCopasiParameter::DOUBLE, (C_FLOAT64)1E-6)->getValue().pDOUBLE;
  mpThreshold  = assertParameter("Threshold", CCopasiParameter::DOUBLE, (C_FLOAT64)0)->getValue().pDOUBLE;
  mpFlagLimitOutConvergence  = assertParameter("DelayOutputUntilConvergence", CCopasiParameter::BOOL, false)->getValue().pBOOL;
  mpConvergenceOutTolerance  = assertParameter("OutputConvergenceTolerance", CCopasiParameter::DOUBLE, (C_FLOAT64)1E-6)->getValue().pDOUBLE;
  mpTriggerExpression =
    assertParameter("TriggerExpression", CCopasiParameter::EXPRESSION, std::string(""))->getValue().pEXPRESSION;
  mSingleObjectCN = assertParameter("SingleVariable", CCopasiParameter::CN, CCopasiObjectName(""))->getValue().pCN;
}

void CCrossSectionProblem::initObjects ( )

private

Definition at line 68 of file CCrossSectionProblem.cpp.

Referenced by CCrossSectionProblem().

{
  //here we should create things like object references to results of the calculation
}

bool CCrossSectionProblem::isPositiveDirection

(

)

const

Definition at line 109 of file CCrossSectionProblem.cpp.

References mpFlagPositiveDirection.

Referenced by CCrossSectionTask::createEvent(), and CQCrossSectionTaskWidget::loadTask().

{
  return *mpFlagPositiveDirection;
}

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

virtual

This is the output method for any object. It calls the insert operator<<

Parameters

std::ostream

* ostream

Reimplemented from CCopasiProblem.

Definition at line 88 of file CCrossSectionProblem.cpp.

{*ostream << *this;}

void CCrossSectionProblem::setConvergenceOutTolerance

(

const C_FLOAT64 &

convergenceTolerance

)

Function to set mpConvergenceOutTolerance

Definition at line 203 of file CCrossSectionProblem.cpp.

References mpConvergenceOutTolerance.

Referenced by CQCrossSectionTaskWidget::commitInput(), CQCrossSectionTaskWidget::saveTask(), and CQCrossSectionTaskWidget::slotOutputConvergence().

{
  *mpConvergenceOutTolerance = convergenceTolerance;
}

void CCrossSectionProblem::setConvergenceTolerance

(

const C_FLOAT64 &

convergenceTolerance

)

Function to set mpConvergenceTolerance

Definition at line 183 of file CCrossSectionProblem.cpp.

References mpConvergenceTolerance.

Referenced by CQCrossSectionTaskWidget::commitInput(), CQCrossSectionTaskWidget::saveTask(), and CQCrossSectionTaskWidget::slotUpdateConvergence().

{
  *mpConvergenceTolerance = convergenceTolerance;
}

void CCrossSectionProblem::setCrossingsLimit

(

const unsigned C_INT32 &

crossingLimit

)

Function to set mpCrossingsLimit

Definition at line 121 of file CCrossSectionProblem.cpp.

References mpCrossingsLimit.

Referenced by CQCrossSectionTaskWidget::commitInput(), CQCrossSectionTaskWidget::saveTask(), and CQCrossSectionTaskWidget::slotUpdateCrossings().

{*mpCrossingsLimit = crossingLimit;}

void CCrossSectionProblem::setFlagLimitConvergence

(

bool

flagLimitConvergence

)

Function to set mpFlagLimitConvergence

Definition at line 178 of file CCrossSectionProblem.cpp.

References mpFlagLimitConvergence.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{
  *mpFlagLimitConvergence = flagLimitConvergence;
}

void CCrossSectionProblem::setFlagLimitCrossings

(

bool

flagLimitCrossing

)

Function to set mpFlagLimitCrossings

Definition at line 118 of file CCrossSectionProblem.cpp.

References mpFlagLimitCrossings.

Referenced by CQCrossSectionTaskWidget::commitInput(), CQCrossSectionTaskWidget::saveTask(), and CQCrossSectionTaskWidget::slotUpdateCrossings().

{*mpFlagLimitCrossings = flagLimitCrossing;}

void CCrossSectionProblem::setFlagLimitOutConvergence

(

bool

flagLimitConvergence

)

Function to set mpFlagLimitOutConvergence

Definition at line 198 of file CCrossSectionProblem.cpp.

References mpFlagLimitOutConvergence.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{
  *mpFlagLimitOutConvergence = flagLimitConvergence;
}

void CCrossSectionProblem::setFlagLimitOutCrossings

(

bool

flagLimitCrossing

)

Function to set mpFlagLimitOutCrossings

Definition at line 124 of file CCrossSectionProblem.cpp.

References mpFlagLimitOutCrossings.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{*mpFlagLimitOutCrossings = flagLimitCrossing;}

void CCrossSectionProblem::setFlagLimitOutTime

(

bool

flagLimitTime

)

Function to set mpFlagLimitOutTime

Definition at line 130 of file CCrossSectionProblem.cpp.

References mpFlagLimitOutTime.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{*mpFlagLimitOutTime = flagLimitTime;}

void CCrossSectionProblem::setOutCrossingsLimit

(

const unsigned C_INT32 &

crossingLimit

)

Function to set mpOutCrossingsLimit

Definition at line 127 of file CCrossSectionProblem.cpp.

References mpOutCrossingsLimit.

Referenced by CQCrossSectionTaskWidget::commitInput(), CQCrossSectionTaskWidget::saveTask(), and CQCrossSectionTaskWidget::slotOutputCrossings().

{*mpOutCrossingsLimit = crossingLimit;}

void CCrossSectionProblem::setPositiveDirection

(

bool

isPositive

)

Definition at line 113 of file CCrossSectionProblem.cpp.

References mpFlagPositiveDirection.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{
  *mpFlagPositiveDirection = isPositive;
}

void CCrossSectionProblem::setSingleObjectCN

(

const std::string &

cn

)

Definition at line 163 of file CCrossSectionProblem.cpp.

References mSingleObjectCN.

Referenced by CQCrossSectionTaskWidget::commitInput(), CQCrossSectionTaskWidget::saveTask(), and setSingleObjectCN().

{
  *mSingleObjectCN = cn;
}

void CCrossSectionProblem::setSingleObjectCN

(

const CCopasiObject *

pObject

)

Definition at line 144 of file CCrossSectionProblem.cpp.

References CCopasiObject::getCN(), and setSingleObjectCN().

{
  if (pObject == NULL) return;

  setSingleObjectCN(pObject->getCN());
}

void CCrossSectionProblem::setThreshold

(

const C_FLOAT64 &

threshold

)

Definition at line 155 of file CCrossSectionProblem.cpp.

References mpThreshold.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{
  *mpThreshold = threshold;
}

void CCrossSectionProblem::setTimeLimit

(

const C_FLOAT64 &

timeLimit

)

Function to set mpTimeLimit

Definition at line 133 of file CCrossSectionProblem.cpp.

References CTrajectoryProblem::mpDuration.

Referenced by CQCrossSectionTaskWidget::commitInput(), and CQCrossSectionTaskWidget::saveTask().

{*mpDuration = timeLimit;}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CCrossSectionProblem &  o  )

friend

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

Parameters

std::ostream	* ostream Output stream operator. Prints description of the problem
ostream	& os
const	Problem & A

Returns

ostream & os

Definition at line 79 of file CCrossSectionProblem.cpp.

{
  os << "Cross Section Problem description: Not implemented yet." << std::endl;
  const CCopasiDataModel* pDataModel = o.getObjectDataModel();
  assert(pDataModel != NULL);

  return os;
}

Member Data Documentation

C_FLOAT64* CCrossSectionProblem::mpConvergenceOutTolerance

private

this variable indicates the tolerance after which the calculation should be considered converged and output should commence

this member variable is mapped to a CCopasiParameter

Definition at line 229 of file CCrossSectionProblem.h.

Referenced by getConvergenceOutTolerance(), initializeParameter(), and setConvergenceOutTolerance().

C_FLOAT64* CCrossSectionProblem::mpConvergenceTolerance

private

this variable indicates the tolerance after which the calculation should be considered converged

this member variable is mapped to a CCopasiParameter

Definition at line 213 of file CCrossSectionProblem.h.

Referenced by getConvergenceTolerance(), initializeParameter(), and setConvergenceTolerance().

unsigned C_INT32* CCrossSectionProblem::mpCrossingsLimit

private

this variable indicates after how many crossings the calculation should be stopped if the corresponding flag is true.

this member variable is mapped to a CCopasiParameter

Definition at line 198 of file CCrossSectionProblem.h.

Referenced by getCrossingsLimit(), initializeParameter(), and setCrossingsLimit().

bool* CCrossSectionProblem::mpFlagLimitConvergence

private

this flag indicates whether the calculation should be stopped when convergence is reached

this member variable is mapped to a CCopasiParameter

Definition at line 205 of file CCrossSectionProblem.h.

Referenced by getFlagLimitConvergence(), initializeParameter(), and setFlagLimitConvergence().

bool* CCrossSectionProblem::mpFlagLimitCrossings

private

this flag indicates whether the calculation should be stopped after a given number of detected crossings

this member variable is mapped to a CCopasiParameter

Definition at line 190 of file CCrossSectionProblem.h.

Referenced by getFlagLimitCrossings(), initializeParameter(), and setFlagLimitCrossings().

bool* CCrossSectionProblem::mpFlagLimitOutConvergence

private

this flag indicates whether the output should only be collected once convergence is reached

this member variable is mapped to a CCopasiParameter

Definition at line 221 of file CCrossSectionProblem.h.

Referenced by getFlagLimitOutConvergence(), initializeParameter(), and setFlagLimitOutConvergence().

bool* CCrossSectionProblem::mpFlagLimitOutCrossings

private

this flag indicates whether the output should be collected after a given number of detected crossings

this member variable is mapped to a CCopasiParameter

Definition at line 237 of file CCrossSectionProblem.h.

Referenced by getFlagLimitOutCrossings(), initializeParameter(), and setFlagLimitOutCrossings().

bool* CCrossSectionProblem::mpFlagLimitOutTime

private

this flag indicates whether output should be selected after a delay

this member variable is mapped to a CCopasiParameter

Definition at line 252 of file CCrossSectionProblem.h.

Referenced by getFlagLimitOutTime(), initializeParameter(), and setFlagLimitOutTime().

bool* CCrossSectionProblem::mpFlagPositiveDirection

private

Definition at line 261 of file CCrossSectionProblem.h.

Referenced by initializeParameter(), isPositiveDirection(), and setPositiveDirection().

unsigned C_INT32* CCrossSectionProblem::mpOutCrossingsLimit

private

this variable indicates after how many crossings the output should start if the corresponding flag is true.

this member variable is mapped to a CCopasiParameter

Definition at line 245 of file CCrossSectionProblem.h.

Referenced by getOutCrossingsLimit(), initializeParameter(), and setOutCrossingsLimit().

C_FLOAT64* CCrossSectionProblem::mpThreshold

private

Definition at line 262 of file CCrossSectionProblem.h.

Referenced by getThreshold(), initializeParameter(), and setThreshold().

std::string* CCrossSectionProblem::mpTriggerExpression

private

this variable holds the trigger expression

this member variable is mapped to a CCopasiParameter

Definition at line 259 of file CCrossSectionProblem.h.

Referenced by initializeParameter().

std::string* CCrossSectionProblem::mSingleObjectCN

private

Definition at line 260 of file CCrossSectionProblem.h.

Referenced by getSingleObjectCN(), initializeParameter(), and setSingleObjectCN().

---

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

• CCrossSectionProblem.h
• CCrossSectionProblem.cpp