COPASI API  4.16.103
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CProcessReportItem Class Reference

#include <CProcessReport.h>

Inheritance diagram for CProcessReportItem:
Inheritance graph
Collaboration diagram for CProcessReportItem:
Collaboration graph

Public Member Functions

 CProcessReportItem (const std::string &name, const Type &type, const void *pValue, const void *pEndValue=NULL)
 CProcessReportItem (const CProcessReportItem &src)
const CCopasiParameter::ValuegetEndValue () const
CCopasiParameter::ValuegetEndValue ()
const bool & hasEndValue () const
 ~CProcessReportItem ()
- 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::TypegetType () const
const ValuegetValue () const
ValuegetValue ()
virtual voidgetValuePointer () const
CCopasiObjectgetValueReference () 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
CCopasiParameteroperator= (const CCopasiParameter &rhs)
virtual void print (std::ostream *ostream) const
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 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 const DataObjectSetgetDirectDependencies (const DataObjectSet &context=DataObjectSet()) const
CCopasiContainergetObjectAncestor (const std::string &type) const
CCopasiDataModelgetObjectDataModel ()
const CCopasiDataModelgetObjectDataModel () const
const std::string & getObjectName () const
CCopasiContainergetObjectParent () const
const std::string & getObjectType () const
virtual const
getPrerequisites () const
virtual RefreshgetRefresh () const
UpdateMethodgetUpdateMethod () 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

 CProcessReportItem ()

Private Attributes

CCopasiParameter::Value mEndValue
bool mHasEndValue

Additional Inherited Members

- Public Types inherited from CCopasiParameter
enum  Type {
- Public Types inherited from CCopasiContainer
typedef std::multimap
< std::string, CCopasiObject * > 
- Public Types inherited from CCopasiObject
typedef std::set< const
CCopasiObject * > 
typedef std::vector< Refresh * > DataUpdateSequence
- Public Types inherited from CObjectInterface
typedef std::set< const
CObjectInterface * > 
typedef std::vector
< CObjectInterface * > 
- 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 * > 
- 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 CCopasiParameter
std::string mKey
size_t mSize
Value mValue
- Protected Attributes inherited from CCopasiContainer
objectMap mObjects
- Static Protected Attributes inherited from CCopasiObject
static CRenameHandlersmpRenameHandler = NULL

Detailed Description

Definition at line 30 of file CProcessReport.h.

Constructor & Destructor Documentation

CProcessReportItem::CProcessReportItem ( )
CProcessReportItem::CProcessReportItem ( const std::string &  name,
const Type type,
const void pValue,
const void pEndValue = NULL 

Specific constructor

conststring & name
constCCopasiParameter::Type & type
constvoid * pValue
constvoid * pEndValue (default: NULL)

Definition at line 36 of file CProcessReport.cpp.

References mEndValue, CCopasiParameter::mValue, and CCopasiParameter::Value::pVOID.

39  :
40  CCopasiParameter(name, type, pEndValue, NULL, "ProcessReportItem"),
41  mEndValue(),
42  mHasEndValue(pEndValue != NULL)
43 {
44  mEndValue = mValue;
45  mValue.pVOID = const_cast<void *>(pValue);
46 }
CCopasiParameter::Value mEndValue
CProcessReportItem::CProcessReportItem ( const CProcessReportItem src)

Copy Constructor

constCProcessReportItem & src

Definition at line 48 of file CProcessReport.cpp.

References mEndValue, and CCopasiParameter::mValue.

48  :
49  CCopasiParameter(src.getObjectName(), src.getType(), src.mEndValue.pVOID, NULL, "ProcessReportItem"),
50  mEndValue(),
52 {
53  mEndValue = mValue;
54  mValue = src.mValue;
55 }
const std::string & getObjectName() const
const CCopasiParameter::Type & getType() const
CCopasiParameter::Value mEndValue
CProcessReportItem::~CProcessReportItem ( )


Definition at line 57 of file CProcessReport.cpp.

References mEndValue, and CCopasiParameter::mValue.

58 {
59  mValue = mEndValue;
60 }
CCopasiParameter::Value mEndValue

Member Function Documentation

const CCopasiParameter::Value & CProcessReportItem::getEndValue ( ) const

Retrieve the private end value of the parameter. This method returns NULL if no end value has been set.

const CCopasiParameter::Value & endValue

Definition at line 64 of file CProcessReport.cpp.

References mEndValue.

Referenced by CQProgressItemBar::initFromProcessReportItem().

65 {return mEndValue;}
CCopasiParameter::Value mEndValue
CCopasiParameter::Value & CProcessReportItem::getEndValue ( )

Retrieve the private end value of the parameter.

CCopasiParameter::Value & endValue

Definition at line 67 of file CProcessReport.cpp.

References mEndValue.

68 {return mEndValue;}
CCopasiParameter::Value mEndValue
const bool & CProcessReportItem::hasEndValue ( ) const

Retrieve whether the item has an end value.

const bool & hasEndValue

Definition at line 62 of file CProcessReport.cpp.

References mHasEndValue.

62 {return mHasEndValue;}

Member Data Documentation

CCopasiParameter::Value CProcessReportItem::mEndValue

A pointer to the value of the parameter.

Definition at line 84 of file CProcessReport.h.

Referenced by CProcessReportItem(), getEndValue(), and ~CProcessReportItem().

bool CProcessReportItem::mHasEndValue

Indicator whether an endvalue has been provided

Definition at line 89 of file CProcessReport.h.

Referenced by hasEndValue().

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