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

#include <COutputDefinitionVector.h>

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

Public Member Functions

void cleanup ()
 
 COutputDefinitionVector (const std::string &name="OutputDefinitions", const CCopasiContainer *pParent=NULL)
 
CPlotSpecificationcreatePlotSpec (const std::string &name, CPlotItem::Type type=CPlotItem::plot2d)
 
const std::string & getKey () const
 
bool removePlotSpec (const std::string &key)
 
virtual ~COutputDefinitionVector ()
 
- Public Member Functions inherited from CCopasiVectorN< CPlotSpecification >
virtual bool add (const CPlotSpecification &src)
 
virtual bool add (CPlotSpecification *src, const bool &adopt=false)
 
 CCopasiVectorN (const std::string &name="NoName", const CCopasiContainer *pParent=NULL)
 
 CCopasiVectorN (const CCopasiVectorN< CPlotSpecification > &src, const CCopasiContainer *pParent=NULL)
 
virtual size_t getIndex (const std::string &name) const
 
virtual const CObjectInterfacegetObject (const CCopasiObjectName &name) const
 
CCopasiVectorN
< CPlotSpecification > & 
operator= (const std::vector< CPlotSpecification * > &rhs)
 
value_typeoperator[] (const size_t &index)
 
const value_typeoperator[] (const size_t &index) const
 
value_typeoperator[] (const std::string &name)
 
const value_typeoperator[] (const std::string &name) const
 
virtual void remove (const std::string &name)
 
virtual ~CCopasiVectorN ()
 
- Public Member Functions inherited from CCopasiVector< T >
virtual bool add (const CType &src)
 
virtual bool add (CType *src, bool adopt=false)
 
iterator begin ()
 
const_iterator begin () const
 
 CCopasiVector (const std::string &name="NoName", const CCopasiContainer *pParent=NULL, const unsigned C_INT32 &flag=CCopasiObject::Vector)
 
 CCopasiVector (const CCopasiVector< CType > &src, const CCopasiContainer *pParent=NULL)
 
virtual void clear ()
 
void deepCopy (const CCopasiVector< CType > &source)
 
iterator end ()
 
const_iterator end () const
 
virtual size_t getIndex (const CCopasiObject *pObject) const
 
CCopasiVector< CType > & operator= (const CCopasiVector< CType > &rhs)
 
CCopasiVector< CType > & operator= (const std::vector< CType * > &rhs)
 
const value_typeoperator[] (const size_t &index) const
 
value_typeoperator[] (const size_t &index)
 
virtual void remove (const size_t &index)
 
virtual bool remove (CCopasiObject *pObject)
 
virtual void resize (const size_t &newSize)
 
virtual size_t size () const
 
virtual void swap (const size_t &indexFrom, const size_t &indexTo)
 
virtual ~CCopasiVector ()
 
- 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 objectMapgetObjects () const
 
virtual std::string getUnits () const
 
virtual const CCopasiObjectgetValueObject () const
 
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 ()
 

Private Attributes

std::string mKey
 

Additional Inherited Members

- Public Types inherited from CCopasiVectorN< CPlotSpecification >
typedef std::vector
< CPlotSpecification * >
::const_iterator 
const_iterator
 
typedef std::vector
< CPlotSpecification * >
::iterator 
iterator
 
typedef std::vector
< CPlotSpecification * >
::value_type 
value_type
 
- Public Types inherited from CCopasiVector< T >
typedef std::vector< CType * >
::const_iterator 
const_iterator
 
typedef std::vector< CType * >
::iterator 
iterator
 
typedef std::vector< CType * >
::value_type 
value_type
 
- 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 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 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 >
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 CCopasiContainer
objectMap mObjects
 
- Static Protected Attributes inherited from CCopasiObject
static CRenameHandlersmpRenameHandler = NULL
 

Detailed Description

Definition at line 29 of file COutputDefinitionVector.h.

Constructor & Destructor Documentation

COutputDefinitionVector::COutputDefinitionVector ( const std::string &  name = "OutputDefinitions",
const CCopasiContainer pParent = NULL 
)

Definition at line 27 of file COutputDefinitionVector.cpp.

28  :
30  mKey(CCopasiRootContainer::getKeyFactory()->add("COutputDefinitionVector", this))
31 {}
std::string add(const std::string &prefix, CCopasiObject *pObject)
static CKeyFactory * getKeyFactory()
COutputDefinitionVector::~COutputDefinitionVector ( )
virtual

Definition at line 33 of file COutputDefinitionVector.cpp.

References cleanup().

34 {
35  cleanup();
36 }

Member Function Documentation

void COutputDefinitionVector::cleanup ( )
virtual

Cleanup

Reimplemented from CCopasiVector< T >.

Definition at line 38 of file COutputDefinitionVector.cpp.

References CCopasiRootContainer::getKeyFactory(), mKey, and CKeyFactory::remove().

Referenced by ~COutputDefinitionVector().

39 {
41 }
bool remove(const std::string &key)
static CKeyFactory * getKeyFactory()
CPlotSpecification * COutputDefinitionVector::createPlotSpec ( const std::string &  name,
CPlotItem::Type  type = CPlotItem::plot2d 
)

Definition at line 48 of file COutputDefinitionVector.cpp.

References CCopasiVectorN< CPlotSpecification >::add(), CCopasiObject::setObjectName(), and CCopasiVector< T >::size().

Referenced by CQPlotSubwidget::addPlot(), COutputAssistant::createDefaultOutput(), COutputAssistant::createPlot(), and SEDMLImporter::readListOfPlotsFromSedMLOutput().

50 {
51  size_t i;
52 
53  for (i = 0; i < size(); i++)
54  if ((*this)[i]->getObjectName() == name)
55  return NULL; // duplicate name
56 
57  CPlotSpecification* pNewPlotSpec = new CPlotSpecification(name, this, type);
58  pNewPlotSpec->setObjectName(name);
59 
60  add(pNewPlotSpec);
61  return pNewPlotSpec;
62 }
virtual size_t size() const
virtual bool add(const CPlotSpecification &src)
bool setObjectName(const std::string &name)
const std::string & COutputDefinitionVector::getKey ( ) const
virtual

Reimplemented from CCopasiObject.

Definition at line 43 of file COutputDefinitionVector.cpp.

References mKey.

Referenced by CQBrowserPaneDM::load().

44 {
45  return mKey;
46 }
bool COutputDefinitionVector::removePlotSpec ( const std::string &  key)

Definition at line 64 of file COutputDefinitionVector.cpp.

References C_INVALID_INDEX, CKeyFactory::get(), CCopasiVector< T >::getIndex(), CCopasiRootContainer::getKeyFactory(), and CCopasiVector< T >::remove().

Referenced by CQPlotSubwidget::deletePlot().

65 {
66  CPlotSpecification* pPl =
68  size_t index = this->CCopasiVector<CPlotSpecification>::getIndex(pPl);
69 
70  if (index == C_INVALID_INDEX)
71  return false;
72 
74 
75  return true;
76 }
CCopasiObject * get(const std::string &key)
#define C_INVALID_INDEX
Definition: copasi.h:222
virtual void remove(const size_t &index)
virtual size_t getIndex(const CCopasiObject *pObject) const
static CKeyFactory * getKeyFactory()

Member Data Documentation

std::string COutputDefinitionVector::mKey
private

Definition at line 32 of file COutputDefinitionVector.h.

Referenced by cleanup(), and getKey().


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