#include <CSensTask.h>

Inheritance diagram for CSensTask:

Collaboration diagram for CSensTask:

Public Member Functions
virtual CCopasiMethod *	createMethod (const int &type) const

	CSensTask (const CCopasiContainer *pParent=NULL)

	CSensTask (const CSensTask &src, const CCopasiContainer *pParent=NULL)

virtual bool	initialize (const OutputFlag &of, COutputHandler pOutputHandler, std::ostream pOstream)

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

virtual bool	process (const bool &useInitialValues)

virtual bool	restore ()

virtual bool	updateMatrices ()

virtual	~CSensTask ()

Public Member Functions inherited from CCopasiTask
	CCopasiTask (const std::string &name="NoName", const CCopasiContainer *pParent=NULL, const std::string &type="Task")

	CCopasiTask (const Type &taskType, const CCopasiContainer *pParent=NULL, const std::string &type="Task")

	CCopasiTask (const CCopasiTask &src, const CCopasiContainer *pParent=NULL)

void	cleanup ()

CProcessReport *	getCallBack () const

const CDescription &	getDescription () const

virtual const std::string &	getKey () const

CCopasiMethod *	getMethod ()

const CCopasiMethod *	getMethod () const

COutputHandler *	getOutputHandler () const

const OutputFlag &	getOutputMode () const

CCopasiProblem *	getProblem ()

const CCopasiProblem *	getProblem () const

CReport &	getReport ()

const CResult &	getResult () const

CCopasiParameterGroup *	getSliders ()

Type	getType () const

const bool &	isScheduled () const

const bool &	isUpdateModel () const

virtual void	output (const COutputInterface::Activity &activity)

virtual void	separate (const COutputInterface::Activity &activity)

virtual bool	setCallBack (CProcessReport *pCallBack)

virtual bool	setMethodType (const int &type)

void	setScheduled (const bool &scheduled)

void	setType (const Type &type)

void	setUpdateModel (const bool &updateModel)

virtual	~CCopasiTask ()

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 CObjectInterface *	getObject (const CCopasiObjectName &cn) 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 CCopasiObjectName	getCN () const

virtual const DataObjectSet &	getDirectDependencies (const DataObjectSet &context=DataObjectSet()) const

CCopasiContainer *	getObjectAncestor (const std::string &type) const

CCopasiDataModel *	getObjectDataModel ()

const CCopasiDataModel *	getObjectDataModel () const

virtual std::string	getObjectDisplayName (bool regular=true, bool richtext=false) 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

virtual void *	getValuePointer () 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
void	cleanup ()

Friends
std::ostream &	operator<< (std::ostream &os, const CSensTask &A)

Additional Inherited Members
Public Types inherited from CCopasiTask
enum	eOutputFlagBase { INITIALIZE = 0x01, STREAM = 0x02, FINISH = 0x04, REPORT = 0x10, PLOT = 0x20, TIME_SERIES = 0x40 }

enum	OutputFlag { NO_OUTPUT = 0, OUTPUT_BEFORE = INITIALIZE, OUTPUT_AFTER = FINISH, OUTPUT = REPORT \| PLOT \| STREAM, OUTPUT_SE = REPORT \| PLOT \| INITIALIZE \| STREAM \| FINISH, OUTPUT_UI = REPORT \| PLOT \| TIME_SERIES \| INITIALIZE \| STREAM \| FINISH, ONLY_TIME_SERIES = TIME_SERIES \| INITIALIZE \| STREAM \| FINISH }

enum	Type { steadyState = 0, timeCourse, scan, fluxMode, optimization, parameterFitting, mca, lyap, tssAnalysis, sens, moieties, crosssection, lna, unset }

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 CCopasiTask
static bool	isValidMethod (const unsigned int &method, const unsigned int *validMethods)

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)

Public Attributes inherited from CCopasiTask
std::string	Error

std::string	Warning

Static Public Attributes inherited from CCopasiTask
static const std::string	TypeName []

static const unsigned int	ValidMethods []

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 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 CCopasiTask
CDescription	mDescription

OutputFlag	mDoOutput

std::string	mKey

unsigned C_INT32	mOutputCounter

CProcessReport *	mpCallBack

CState *	mpInitialState

CCopasiMethod *	mpMethod

COutputHandler *	mpOutputHandler

CCopasiProblem *	mpProblem

CCopasiParameterGroup *	mpSliders

CReport	mReport

CResult	mResult

bool	mScheduled

Type	mType

bool	mUpdateModel

Protected Attributes inherited from CCopasiContainer
objectMap	mObjects

Static Protected Attributes inherited from CCopasiObject
static CRenameHandler *	smpRenameHandler = NULL

Detailed Description

CSensTask class.

Definition at line 35 of file CSensTask.h.

Constructor & Destructor Documentation

CSensTask::CSensTask ( const CCopasiContainer * pParent = NULL )

Default constructor

Parameters

const CCopasiContainer * pParent (default: NULL)

Definition at line 41 of file CSensTask.cpp.

References CCopasiContainer::add(), createMethod(), CCopasiTask::mpMethod, CCopasiTask::mpProblem, and CCopasiMethod::sensMethod.

                                                     :
     CCopasiTask(CCopasiTask::sens, pParent)
 {
   mpProblem = new CSensProblem(this);
 
   mpMethod = createMethod(CCopasiMethod::sensMethod);
   this->add(mpMethod, true);
 
 }

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

Copy constructor

Parameters

const	CSensTask & src
const	CCopasiContainer * pParent (default: NULL)

Definition at line 51 of file CSensTask.cpp.

References CCopasiContainer::add(), createMethod(), CCopasiMethod::getSubType(), CCopasiTask::mpMethod, and CCopasiTask::mpProblem.

                                                       :
     CCopasiTask(src, pParent)
 {
   mpProblem =
     new CSensProblem(*(CSensProblem *) src.mpProblem, this);
 
   mpMethod = createMethod(src.mpMethod->getSubType());
   this->add(mpMethod, true);
 }

CSensTask::~CSensTask ( )

virtual

Destructor

Definition at line 62 of file CSensTask.cpp.

63 {}

Member Function Documentation

void CSensTask::cleanup ( )

private

cleanup()

Definition at line 73 of file CSensTask.cpp.

74 {}

CCopasiMethod * CSensTask::createMethod ( const int & type ) const

virtual

Create a method of the specified type to solve the task. It is the duty of the caller to release the CCopasiMethod.

Parameters

const CCopasiMethod::SubType & type

Returns: CCopasiMethod *

Reimplemented from CCopasiTask.

Definition at line 66 of file CSensTask.cpp.

References CSensMethod::createMethod().

Referenced by CSensTask().

 {
   CCopasiMethod::SubType Type = (CCopasiMethod::SubType) type;
 
   return CSensMethod::createMethod(Type);
 }

bool CSensTask::initialize	(	const OutputFlag &	of,
		COutputHandler *	pOutputHandler,
		std::ostream *	pOstream
	)

virtual

Initialize the task. If an ostream is given this ostream is used instead of the target specified in the report. This allows nested tasks to share the same output device.

Parameters

const	OutputFlag & of
COutputHandler	* pOutputHandler
std::ostream	* pOstream (default: NULL)

Returns: bool success

Reimplemented from CCopasiTask.

Definition at line 101 of file CSensTask.cpp.

References CCopasiTask::initialize(), and updateMatrices().

 {
 
   bool success = true;
 
   //this needs to be done before the initialization of the output
   if (!updateMatrices()) success = false;
 
   if (!CCopasiTask::initialize(of, pOutputHandler, pOstream)) success = false;
 
   return success;
 }

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

virtual

This is the output method for any object. The default implementation provided with CCopasiObject uses the ostream operator<< of the object to print the object.To overide this default behaviour one needs to reimplement the virtual print function.

Parameters

std::ostream * ostream

Reimplemented from CCopasiObject.

Definition at line 77 of file CSensTask.cpp.

77 {(*ostream) << (*this);}

bool CSensTask::process ( const bool & useInitialValues )

virtual

Process the task with or without initializing to the initial state.

Parameters

const bool & useInitialValues

Returns: bool success

Reimplemented from CCopasiTask.

Definition at line 116 of file CSensTask.cpp.

References COutputInterface::AFTER, CModel::applyInitialValues(), COutputInterface::BEFORE, COutputInterface::DURING, CCopasiProblem::getModel(), CCopasiMethod::isValidProblem(), CCopasiTask::mpCallBack, CCopasiTask::mpMethod, CCopasiTask::mpProblem, CCopasiTask::mReport, CReport::output(), and CSensMethod::process().

 {
   assert(/*mpProblem && */mpMethod);
   mpMethod->isValidProblem(mpProblem);
 
   CSensProblem* pProblem =
     dynamic_cast<CSensProblem *>(mpProblem);
   assert(pProblem);
 
   CSensMethod* pMethod =
     dynamic_cast<CSensMethod *>(mpMethod);
   assert(pMethod);
 
   if (useInitialValues)
     pProblem->getModel()->applyInitialValues();
 
   mReport.output(COutputInterface::BEFORE);
 
   bool success = pMethod->process(mpCallBack);
 
   mReport.output(COutputInterface::DURING);
   mReport.output(COutputInterface::AFTER);
 
   return (success);
 }

bool CSensTask::restore ( )

virtual

Perform necessary cleanup procedures

Reimplemented from CCopasiTask.

Definition at line 143 of file CSensTask.cpp.

References CCopasiTask::mpMethod, CCopasiTask::mUpdateModel, and CSensMethod::restore().

 {
   bool success = true;
 
   CSensMethod* pMethod =
     dynamic_cast<CSensMethod *>(mpMethod);
 
   if (pMethod != NULL)
     pMethod->restore(mUpdateModel);
 
   return success;
 }

bool CSensTask::updateMatrices ( )

virtual

Resizes result matrices and updates array annotations. This is used when we need to know about the data structures of a task result without actually performing the task, e.g. when selecting objects for output. For now we assume that this functionality is also performed when initialize() is called.

Reimplemented from CCopasiTask.

Definition at line 79 of file CSensTask.cpp.

References CModel::compileIfNecessary(), CCopasiProblem::getModel(), CSensMethod::initialize(), CCopasiTask::mpCallBack, CCopasiTask::mpMethod, and CCopasiTask::mpProblem.

Referenced by initialize().

 {
   assert(mpProblem && mpMethod);
 
   CSensProblem* pProblem =
     dynamic_cast<CSensProblem *>(mpProblem);
   assert(pProblem);
 
   CSensMethod* pMethod =
     dynamic_cast<CSensMethod *>(mpMethod);
   assert(pMethod);
 
   bool success = true;
 
   if (!pProblem->getModel()->compileIfNecessary(mpCallBack)) success = false;
 
   //this does actually more than just update the matrices, but it should do no harm
   if (!pMethod->initialize(pProblem)) success = false;
 
   return success;
 }

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CSensTask &	A
	)

friend

Definition at line 156 of file CSensTask.cpp.

 {
   return os;
 }

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

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation