COPASI API  4.16.103
Public Member Functions | Static Public Attributes | List of all members
COscillationTask Class Reference

#include <COscillationTask.h>

Inheritance diagram for COscillationTask:
Inheritance graph
[legend]
Collaboration diagram for COscillationTask:
Collaboration graph
[legend]

Public Member Functions

void cleanup ()
 
 COscillationTask (const CCopasiTask::Type &type, const CCopasiContainer *pParent)
 
 COscillationTask (const COscillationTask &src, const CCopasiContainer *pParent=NULL)
 
virtual CCopasiMethodcreateMethod (const int &type) const
 
virtual bool initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
 
virtual bool process (const bool &useInitialValues)
 
virtual bool setCallBack (CProcessReport *pCallBack)
 
virtual bool setMethodType (const int &type)
 
 ~COscillationTask ()
 
- 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 ()
 
CProcessReportgetCallBack () const
 
const CDescriptiongetDescription () const
 
virtual const std::string & getKey () const
 
CCopasiMethodgetMethod ()
 
const CCopasiMethodgetMethod () const
 
COutputHandlergetOutputHandler () const
 
const OutputFlaggetOutputMode () const
 
CCopasiProblemgetProblem ()
 
const CCopasiProblemgetProblem () const
 
CReportgetReport ()
 
const CResultgetResult () const
 
CCopasiParameterGroupgetSliders ()
 
Type getType () const
 
const bool & isScheduled () const
 
const bool & isUpdateModel () const
 
virtual void output (const COutputInterface::Activity &activity)
 
virtual bool restore ()
 
virtual void separate (const COutputInterface::Activity &activity)
 
void setScheduled (const bool &scheduled)
 
void setType (const Type &type)
 
void setUpdateModel (const bool &updateModel)
 
virtual bool updateMatrices ()
 
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 CObjectInterfacegetObject (const CCopasiObjectName &cn) const
 
virtual const objectMapgetObjects () const
 
virtual std::string getUnits () const
 
virtual const CCopasiObjectgetValueObject () 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 DataObjectSetgetDirectDependencies (const DataObjectSet &context=DataObjectSet()) const
 
CCopasiContainergetObjectAncestor (const std::string &type) const
 
CCopasiDataModelgetObjectDataModel ()
 
const CCopasiDataModelgetObjectDataModel () const
 
virtual std::string getObjectDisplayName (bool regular=true, bool richtext=false) const
 
const std::string & getObjectName () const
 
CCopasiContainergetObjectParent () const
 
const std::string & getObjectType () const
 
virtual const
CObjectInterface::ObjectSet
getPrerequisites () const
 
virtual RefreshgetRefresh () const
 
UpdateMethodgetUpdateMethod () const
 
virtual voidgetValuePointer () 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
 
virtual void print (std::ostream *ostream) 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 ()
 

Static Public Attributes

static unsigned C_INT32 ValidMethods []
 
- 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
 

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
 
- 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 >
CCopasiObjectaddMatrixReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
 
template<class CType >
CCopasiObjectaddObjectReference (const std::string &name, CType &reference, const unsigned C_INT32 &flag=0)
 
template<class CType >
CCopasiObjectaddVectorReference (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
 
CProcessReportmpCallBack
 
CStatempInitialState
 
CCopasiMethodmpMethod
 
COutputHandlermpOutputHandler
 
CCopasiProblemmpProblem
 
CCopasiParameterGroupmpSliders
 
CReport mReport
 
CResult mResult
 
bool mScheduled
 
Type mType
 
bool mUpdateModel
 
- Protected Attributes inherited from CCopasiContainer
objectMap mObjects
 
- Static Protected Attributes inherited from CCopasiObject
static CRenameHandlersmpRenameHandler = NULL
 

Detailed Description

Definition at line 34 of file COscillationTask.h.

Constructor & Destructor Documentation

COscillationTask::COscillationTask ( const CCopasiTask::Type type,
const CCopasiContainer pParent 
)

default constructor

Parameters
constCCopasiTask::Type & type (default: optimization)
constCCopasiContainer * pParent (default: NULL)

Definition at line 36 of file COscillationTask.cpp.

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

37  :
38  CCopasiTask(type, pParent)
39 {
40  mpProblem = new COscillationProblem(type, this);
42  this->add(mpMethod, true);
44 }
CCopasiMethod * mpMethod
Definition: CCopasiTask.h:239
CCopasiTask(const std::string &name="NoName", const CCopasiContainer *pParent=NULL, const std::string &type="Task")
CCopasiProblem * mpProblem
Definition: CCopasiTask.h:234
static COscillationMethod * createMethod(CCopasiMethod::SubType subType=CCopasiMethod::oscillationIntegrate)
virtual bool add(CCopasiObject *pObject, const bool &adopt=true)
COscillationTask::COscillationTask ( const COscillationTask src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters
constCOscillationTask & src

Definition at line 46 of file COscillationTask.cpp.

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

47  :
48  CCopasiTask(src, pParent)
49 {
52  this->add(mpMethod, true);
54 }
CCopasiMethod * mpMethod
Definition: CCopasiTask.h:239
CCopasiTask(const std::string &name="NoName", const CCopasiContainer *pParent=NULL, const std::string &type="Task")
const CCopasiMethod::SubType & getSubType() const
CCopasiProblem * mpProblem
Definition: CCopasiTask.h:234
static COscillationMethod * createMethod(CCopasiMethod::SubType subType=CCopasiMethod::oscillationIntegrate)
virtual bool add(CCopasiObject *pObject, const bool &adopt=true)
COscillationTask::~COscillationTask ( )

Destructor

Definition at line 56 of file COscillationTask.cpp.

References cleanup().

57 {cleanup();}

Member Function Documentation

void COscillationTask::cleanup ( )

cleanup()

Definition at line 59 of file COscillationTask.cpp.

Referenced by ~COscillationTask().

59 {}
CCopasiMethod * COscillationTask::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
constCCopasiMethod::SubType & type
Returns
CCopasiMethod *

Reimplemented from CCopasiTask.

Definition at line 130 of file COscillationTask.cpp.

References COscillationMethod::createMethod().

Referenced by setMethodType().

131 {
133 
135 }
static COscillationMethod * createMethod(CCopasiMethod::SubType subType=CCopasiMethod::oscillationIntegrate)
bool COscillationTask::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
constOutputFlag & of
COutputHandler* pOutputHandler
std::ostream* pOstream (default: NULL)
Returns
bool success

Reimplemented from CCopasiTask.

Definition at line 72 of file COscillationTask.cpp.

References COscillationProblem::initialize(), CCopasiTask::initialize(), CCopasiTask::mpMethod, CCopasiTask::mpProblem, and COscillationMethod::setProblem().

75 {
76  COscillationProblem * pProblem = dynamic_cast<COscillationProblem *>(mpProblem);
77  COscillationMethod * pMethod = dynamic_cast<COscillationMethod *>(mpMethod);
78 
79  if (!pProblem || !pMethod) return false;
80 
81  //initialize reporting
82  bool success = true;
83 
84  if (!CCopasiTask::initialize(of, pOutputHandler, pOstream)) success = false;
85 
86  //if (!mReport.open(pOstream)) success = false;
87  //if (!mReport.compile()) success = false;
88 
89  if (!pProblem->initialize()) success = false;
90 
91  pMethod->setProblem(pProblem);
92  // if (!pMethod->initialize()) return false;
93 
94  return success;
95 }
CCopasiMethod * mpMethod
Definition: CCopasiTask.h:239
virtual bool initialize(const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
void setProblem(COscillationProblem *problem)
CCopasiProblem * mpProblem
Definition: CCopasiTask.h:234
bool COscillationTask::process ( const bool &  useInitialValues)
virtual

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

Parameters
constbool & useInitialValues
Returns
bool success

Reimplemented from CCopasiTask.

Definition at line 97 of file COscillationTask.cpp.

References COutputInterface::AFTER, COutputInterface::BEFORE, CCopasiMethod::isValidProblem(), CCopasiTask::mpMethod, CCopasiTask::mpProblem, CCopasiTask::output(), and COscillationMethod::run().

98 {
99  COscillationProblem * pProblem = dynamic_cast<COscillationProblem *>(mpProblem);
100  COscillationMethod * pMethod = dynamic_cast<COscillationMethod *>(mpMethod);
101 
102  if (!pProblem || !pMethod) return false;
103 
105 
107 
108  bool success = pMethod->run();
109 
111 
112  return success;
113 }
CCopasiMethod * mpMethod
Definition: CCopasiTask.h:239
virtual void output(const COutputInterface::Activity &activity)
virtual bool isValidProblem(const CCopasiProblem *pProblem)
CCopasiProblem * mpProblem
Definition: CCopasiTask.h:234
virtual bool run()=0
bool COscillationTask::setCallBack ( CProcessReport pCallBack)
virtual

Set the call back of the task

Parameters
CProcessReport* pCallBack
Returns
bool succes

Reimplemented from CCopasiTask.

Definition at line 61 of file COscillationTask.cpp.

References CCopasiTask::mpMethod, CCopasiTask::mpProblem, CCopasiProblem::setCallBack(), CCopasiMethod::setCallBack(), and CCopasiTask::setCallBack().

62 {
63  bool success = CCopasiTask::setCallBack(pCallBack);
64 
65  if (!mpProblem->setCallBack(pCallBack)) success = false;
66 
67  if (!mpMethod->setCallBack(pCallBack)) success = false;
68 
69  return success;
70 }
virtual bool setCallBack(CProcessReport *pCallBack)
CCopasiMethod * mpMethod
Definition: CCopasiTask.h:239
virtual bool setCallBack(CProcessReport *pCallBack)
CCopasiProblem * mpProblem
Definition: CCopasiTask.h:234
virtual bool setCallBack(CProcessReport *pCallBack)
bool COscillationTask::setMethodType ( const int &  type)
virtual

Set the method type applied to solve the task

Parameters
constCCopasiMethod::SubType & type
Returns
bool success

Reimplemented from CCopasiTask.

Definition at line 115 of file COscillationTask.cpp.

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

116 {
118 
119  if (mpMethod->getSubType() == Type) return true;
120 
121  pdelete(mpMethod);
122 
123  mpMethod = createMethod(Type);
124  this->add(mpMethod, true);
125 
126  return true;
127 }
CCopasiMethod * mpMethod
Definition: CCopasiTask.h:239
#define pdelete(p)
Definition: copasi.h:215
const CCopasiMethod::SubType & getSubType() const
virtual CCopasiMethod * createMethod(const int &type) const
virtual bool add(CCopasiObject *pObject, const bool &adopt=true)

Member Data Documentation

const unsigned int COscillationTask::ValidMethods
static
Initial value:
=
{
CCopasiMethod::oscillationIntegrate,
}

The methods which can be selected for preforming this task.

Definition at line 42 of file COscillationTask.h.


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