COPASI API  4.16.103
Public Member Functions | Friends | List of all members
CCopasiTask::CDescription Class Reference

#include <CCopasiTask.h>

Inheritance diagram for CCopasiTask::CDescription:
Inheritance graph
[legend]
Collaboration diagram for CCopasiTask::CDescription:
Collaboration graph
[legend]

Public Member Functions

 CDescription (const CCopasiContainer *pParent=NULL)
 
 CDescription (const CDescription &src, const CCopasiContainer *pParent=NULL)
 
virtual void print (std::ostream *ostream) const
 
virtual ~CDescription ()
 
- 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
 
virtual const std::string & getKey () const
 
virtual const CObjectInterfacegetObject (const CCopasiObjectName &cn) 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
 
virtual std::string getUnits () const
 
UpdateMethodgetUpdateMethod () const
 
virtual const CCopasiObjectgetValueObject () 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
 
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 ()
 

Friends

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

Additional Inherited Members

- 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)
 
- 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 CCopasiObject
 CCopasiObject ()
 
 CCopasiObject (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &type="CN", const unsigned C_INT32 &flag=0)
 
- Static Protected Attributes inherited from CCopasiObject
static CRenameHandlersmpRenameHandler = NULL
 

Detailed Description

Definition at line 114 of file CCopasiTask.h.

Constructor & Destructor Documentation

CCopasiTask::CDescription::CDescription ( const CCopasiContainer pParent = NULL)

Default constructor

Definition at line 397 of file CCopasiTask.cpp.

397  :
398  CCopasiObject("Description", pParent, "Object")
399 {}
CCopasiTask::CDescription::CDescription ( const CDescription src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

Parameters
constCDescription & src
constCCopasiContainer * pParent (default: NULL)

Definition at line 401 of file CCopasiTask.cpp.

402  :
403  CCopasiObject(src, pParent)
404 {}
CCopasiTask::CDescription::~CDescription ( )
virtual

Destructor

Definition at line 406 of file CCopasiTask.cpp.

406 {}

Member Function Documentation

void CCopasiTask::CDescription::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 408 of file CCopasiTask.cpp.

Referenced by operator<<().

409 {*ostream << *this;}

Friends And Related Function Documentation

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

Output stream operator

Parameters
ostream& os
constCDescription & A
Returns
ostream & os

Definition at line 411 of file CCopasiTask.cpp.

413 {
414  const CCopasiTask & Task = *static_cast<const CCopasiTask *>(o.getObjectParent());
415 
416  os << Task.getObjectName() << " Task" << std::endl << std::endl;
417 
418  if (Task.getProblem())
419  {
420  Task.getProblem()->print(&os);
421  os << std::endl;
422  }
423  else
424  os << "No Problem Specified!" << std::endl;
425 
426  if (Task.getMethod())
427  {
428  Task.getMethod()->print(&os);
429  os << std::endl;
430  }
431  else
432  os << "No Method Specified!" << std::endl;
433 
434  return os;
435 }
CCopasiProblem * getProblem()
const std::string & getObjectName() const
virtual void print(std::ostream *ostream) const
virtual void print(std::ostream *ostream) const
CCopasiMethod * getMethod()

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