COPASI API
4.16.103
|
#include <CMoietiesTask.h>
Public Member Functions | |
CMoietiesTask (const CCopasiTask::Type &type=CCopasiTask::moieties, const CCopasiContainer *pParent=NULL) | |
CMoietiesTask (const CMoietiesTask &src, const CCopasiContainer *pParent=NULL) | |
virtual CCopasiMethod * | createMethod (const int &type) const |
virtual bool | initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream) |
virtual bool | process (const bool &useInitialValues) |
virtual bool | restore () |
virtual bool | setCallBack (CProcessReport *pCallBack) |
virtual bool | setMethodType (const int &type) |
~CMoietiesTask () | |
![]() | |
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) |
void | setScheduled (const bool &scheduled) |
void | setType (const Type &type) |
void | setUpdateModel (const bool &updateModel) |
virtual bool | updateMatrices () |
virtual | ~CCopasiTask () |
![]() | |
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 () |
![]() | |
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 |
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 () |
![]() | |
CObjectInterface () | |
virtual | ~CObjectInterface () |
Static Public Attributes | |
static const unsigned int | ValidMethods [] |
![]() | |
static const std::string | TypeName [] |
static const unsigned int | ValidMethods [] |
static const char * | XMLType [] |
![]() | |
static const std::vector < CCopasiContainer * > | EmptyList |
Additional Inherited Members | |
![]() | |
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 } |
![]() | |
typedef std::multimap < std::string, CCopasiObject * > | objectMap |
![]() | |
typedef std::set< const CCopasiObject * > | DataObjectSet |
typedef std::vector< Refresh * > | DataUpdateSequence |
![]() | |
typedef std::set< const CObjectInterface * > | ObjectSet |
typedef std::vector < CObjectInterface * > | UpdateSequence |
![]() | |
static bool | isValidMethod (const unsigned int &method, const unsigned int *validMethods) |
![]() | |
static std::vector< Refresh * > | buildUpdateSequence (const DataObjectSet &objects, const DataObjectSet &uptoDateObjects, const DataObjectSet &context=DataObjectSet()) |
static void | setRenameHandler (CRenameHandler *rh) |
![]() | |
std::string | Error |
std::string | Warning |
![]() | |
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 } |
![]() | |
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 () |
![]() | |
CCopasiObject () | |
CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0) | |
![]() | |
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 |
![]() | |
objectMap | mObjects |
![]() | |
static CRenameHandler * | smpRenameHandler = NULL |
Definition at line 26 of file CMoietiesTask.h.
CMoietiesTask::CMoietiesTask | ( | const CCopasiTask::Type & | type = CCopasiTask::moieties , |
const CCopasiContainer * | pParent = NULL |
||
) |
default constructor
const | CCopasiTask::Type & type (default: moieties) |
const | CCopasiContainer * pParent (default: NULL) |
Definition at line 36 of file CMoietiesTask.cpp.
References CCopasiContainer::add(), CMoietiesMethod::createMethod(), CCopasiTask::mpMethod, and CCopasiTask::mpProblem.
CMoietiesTask::CMoietiesTask | ( | const CMoietiesTask & | src, |
const CCopasiContainer * | pParent = NULL |
||
) |
Copy constructor
const | CMoietiesTask & src |
Definition at line 45 of file CMoietiesTask.cpp.
References CCopasiContainer::add(), CMoietiesMethod::createMethod(), CCopasiMethod::getSubType(), CCopasiTask::mpMethod, and CCopasiTask::mpProblem.
CMoietiesTask::~CMoietiesTask | ( | ) |
|
virtual |
Create a method of the specified type to solve the task. It is the duty of the caller to release the CCopasiMethod.
const | CCopasiMethod::SubType & type |
Reimplemented from CCopasiTask.
Definition at line 147 of file CMoietiesTask.cpp.
References CMoietiesMethod::createMethod().
Referenced by setMethodType().
|
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.
const | OutputFlag & of |
COutputHandler | * pOutputHandler |
std::ostream | * pOstream (default: NULL) |
Reimplemented from CCopasiTask.
Definition at line 71 of file CMoietiesTask.cpp.
References CCopasiTask::initialize(), CCopasiMethod::isValidProblem(), CCopasiTask::mpMethod, CCopasiTask::mpProblem, and CMoietiesMethod::setProblem().
|
virtual |
Process the task with or without initializing to the initial state.
const | bool & useInitialValues |
Reimplemented from CCopasiTask.
Definition at line 91 of file CMoietiesTask.cpp.
References COutputInterface::AFTER, COutputInterface::BEFORE, COutputHandler::compile(), CCopasiMessage::getLastMessage(), CCopasiObject::getObjectDataModel(), CCopasiTask::mpMethod, CCopasiTask::mpOutputHandler, CCopasiTask::output(), and CCopasiMessage::size().
|
virtual |
Perform necessary cleanup procedures
Reimplemented from CCopasiTask.
Definition at line 126 of file CMoietiesTask.cpp.
References CCopasiProblem::getModel(), CCopasiTask::mpProblem, and CModel::updateInitialValues().
|
virtual |
Set the call back of the task
CProcessReport | * pCallBack |
Reimplemented from CCopasiTask.
Definition at line 59 of file CMoietiesTask.cpp.
References CCopasiTask::mpMethod, CCopasiTask::mpProblem, CCopasiProblem::setCallBack(), CCopasiMethod::setCallBack(), and CCopasiTask::setCallBack().
|
virtual |
Set the method type applied to solve the task
const | CCopasiMethod::SubType & type |
Reimplemented from CCopasiTask.
Definition at line 132 of file CMoietiesTask.cpp.
References CCopasiContainer::add(), createMethod(), CCopasiMethod::getSubType(), CCopasiTask::mpMethod, and pdelete.
|
static |
The methods which can be selected for preforming this task.
Definition at line 34 of file CMoietiesTask.h.