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

#include <CConfigurationFile.h>

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

Public Member Functions

void addFile (const std::string &file)
 
 CRecentFiles (const std::string &name="Recent Files", const CCopasiContainer *pParent=NULL)
 
 CRecentFiles (const CRecentFiles &src, const CCopasiContainer *pParent=NULL)
 
 CRecentFiles (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
 
virtual ~CRecentFiles ()
 
- Public Member Functions inherited from CCopasiParameterGroup
bool addGroup (const std::string &name)
 
bool addParameter (const CCopasiParameter &parameter)
 
bool addParameter (const std::string &name, const CCopasiParameter::Type type)
 
template<class CType >
bool addParameter (const std::string &name, const CCopasiParameter::Type type, const CType &value)
 
void addParameter (CCopasiParameter *pParameter)
 
CCopasiParameterGroupassertGroup (const std::string &name)
 
template<class CType >
CCopasiParameterassertParameter (const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue)
 
index_iterator beginIndex () const
 
name_iterator beginName () const
 
 CCopasiParameterGroup (const CCopasiParameterGroup &src, const CCopasiContainer *pParent=NULL)
 
 CCopasiParameterGroup (const std::string &name, const CCopasiContainer *pParent=NULL, const std::string &objectType="ParameterGroup")
 
void clear ()
 
virtual bool elevateChildren ()
 
index_iterator endIndex () const
 
name_iterator endName () const
 
CCopasiParameterGroupgetGroup (const std::string &name)
 
const CCopasiParameterGroupgetGroup (const std::string &name) const
 
CCopasiParameterGroupgetGroup (const size_t &index)
 
const CCopasiParameterGroupgetGroup (const size_t &index) const
 
size_t getIndex (const std::string &name) const
 
std::string getKey (const std::string &name) const
 
std::string getKey (const size_t &index) const
 
virtual const std::string & getName (const size_t &index) const
 
virtual const CObjectInterfacegetObject (const CCopasiObjectName &cn) const
 
CCopasiParametergetParameter (const std::string &name)
 
const CCopasiParametergetParameter (const std::string &name) const
 
CCopasiParametergetParameter (const size_t &index)
 
const CCopasiParametergetParameter (const size_t &index) const
 
CCopasiParameter::Type getType (const std::string &name) const
 
CCopasiParameter::Type getType (const size_t &index) const
 
std::string getUniqueParameterName (const CCopasiParameter *pParameter) const
 
const CCopasiParameter::ValuegetValue (const std::string &name) const
 
const CCopasiParameter::ValuegetValue (const size_t &index) const
 
CCopasiParameter::ValuegetValue (const std::string &name)
 
CCopasiParameter::ValuegetValue (const size_t &index)
 
CCopasiParameterGroupoperator= (const CCopasiParameterGroup &rhs)
 
virtual void print (std::ostream *ostream) const
 
bool removeParameter (const std::string &name)
 
bool removeParameter (const size_t &index)
 
template<class CType >
bool setValue (const std::string &name, const CType &value)
 
template<class CType >
bool setValue (const size_t &index, const CType &value)
 
size_t size () const
 
bool swap (const size_t &iFrom, const size_t &iTo)
 
bool swap (index_iterator &from, index_iterator &to)
 
virtual ~CCopasiParameterGroup ()
 
- 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)
 
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 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
CObjectInterface::ObjectSet
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

void initializeParameter ()
 

Private Attributes

unsigned C_INT32mpMaxFiles
 
CCopasiParameterGroupmpRecentFiles
 

Additional Inherited Members

- Public Types inherited from CCopasiParameterGroup
typedef parameterGroup::iterator index_iterator
 
typedef
CCopasiContainer::objectMap::iterator 
name_iterator
 
typedef std::vector
< CCopasiParameter * > 
parameterGroup
 
- Public Types inherited from CCopasiParameter
enum  Type {
  DOUBLE = 0, UDOUBLE, INT, UINT,
  BOOL, GROUP, STRING, CN,
  KEY, FILE, EXPRESSION, INVALID
}
 
- 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 CCopasiParameter
static const std::string TypeName []
 
static const char * XMLType []
 
- 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 CCopasiParameterGroup
 CCopasiParameterGroup ()
 
- 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
 
CCopasiObjectmpValueReference
 
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 24 of file CConfigurationFile.h.

Constructor & Destructor Documentation

CRecentFiles::CRecentFiles ( const std::string &  name = "Recent Files",
const CCopasiContainer pParent = NULL 
)

Default constructor

Parameters
conststd::string & name (default: Recent Files)
constCCopasiContainer * pParent (default: NULL)

Definition at line 27 of file CConfigurationFile.cpp.

References initializeParameter().

28  :
29  CCopasiParameterGroup(name, pParent),
30  mpMaxFiles(NULL),
31  mpRecentFiles(NULL)
CCopasiParameterGroup * mpRecentFiles
unsigned C_INT32 * mpMaxFiles
CRecentFiles::CRecentFiles ( const CRecentFiles src,
const CCopasiContainer pParent = NULL 
)

Copy constructor

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

Definition at line 34 of file CConfigurationFile.cpp.

References initializeParameter().

35  :
36  CCopasiParameterGroup(src, pParent),
37  mpMaxFiles(NULL),
38  mpRecentFiles(NULL)
CCopasiParameterGroup * mpRecentFiles
unsigned C_INT32 * mpMaxFiles
CRecentFiles::CRecentFiles ( const CCopasiParameterGroup group,
const CCopasiContainer pParent = NULL 
)

Specific constructor

Parameters
constCCopasiParameterGroup & group
constCCopasiContainer * pParent (default: NULL)

Definition at line 41 of file CConfigurationFile.cpp.

References initializeParameter().

42  :
43  CCopasiParameterGroup(group, pParent),
44  mpMaxFiles(NULL),
45  mpRecentFiles(NULL)
CCopasiParameterGroup * mpRecentFiles
unsigned C_INT32 * mpMaxFiles
CRecentFiles::~CRecentFiles ( )
virtual

Destructor

Definition at line 48 of file CConfigurationFile.cpp.

49 {}

Member Function Documentation

void CRecentFiles::addFile ( const std::string &  file)

Add a file to the list of recent files

Parameters
conststd::string & file

Definition at line 58 of file CConfigurationFile.cpp.

References CCopasiParameterGroup::addParameter(), CCopasiParameterGroup::beginIndex(), CCopasiParameterGroup::endIndex(), CDirEntry::fileName(), COptions::getValue(), CDirEntry::isRelativePath(), CDirEntry::makePathAbsolute(), mpMaxFiles, mpRecentFiles, CDirEntry::normalize(), CCopasiParameterGroup::size(), and CCopasiParameter::STRING.

Referenced by DataModelGUI::exportSBMLFinished(), DataModelGUI::importSBMLFinished(), DataModelGUI::loadModelFinished(), and DataModelGUI::saveModelFinished().

59 {
60  std::string FileName = CDirEntry::normalize(file);
61 
62 #ifdef WIN32
63  std::string::size_type pos = FileName.find('\\');
64 
65  while (pos != std::string::npos)
66  {
67  FileName[pos] = '/';
68  pos = FileName.find('\\', pos);
69  }
70 
71 #endif
72 
73  std::string PWD;
74  COptions::getValue("PWD", PWD);
75 
76  if (CDirEntry::isRelativePath(FileName) &&
77  !CDirEntry::makePathAbsolute(FileName, PWD))
78  FileName = CDirEntry::fileName(FileName);
79 
82 
83  std::string NewFile = FileName;
84  std::string ExistingFile;
85 
86  for (; it != end; ++it)
87  {
88  ExistingFile = *(*it)->getValue().pSTRING;
89  (*it)->setValue(NewFile);
90 
91  if (ExistingFile == FileName) return;
92 
93  NewFile = ExistingFile;
94  }
95 
96  if (mpRecentFiles->size() < *mpMaxFiles)
98 
99  return;
100 }
CCopasiParameterGroup * mpRecentFiles
unsigned C_INT32 * mpMaxFiles
static bool isRelativePath(const std::string &path)
Definition: CDirEntry.cpp:414
index_iterator endIndex() const
static std::string fileName(const std::string &path)
Definition: CDirEntry.cpp:119
index_iterator beginIndex() const
static void getValue(const std::string &name, CType &value)
Definition: COptions.h:124
bool addParameter(const CCopasiParameter &parameter)
static std::string normalize(const std::string &path)
Definition: CDirEntry.cpp:560
static bool makePathAbsolute(std::string &relativePath, const std::string &absoluteTo)
Definition: CDirEntry.cpp:481
parameterGroup::iterator index_iterator
void CRecentFiles::initializeParameter ( )
private

Allocates all group parameters and assures that they are properly initialized.

Definition at line 51 of file CConfigurationFile.cpp.

References CCopasiParameterGroup::assertGroup(), CCopasiParameterGroup::assertParameter(), C_INT32, CCopasiParameter::getValue(), mpMaxFiles, mpRecentFiles, CCopasiParameter::Value::pUINT, and CCopasiParameter::UINT.

Referenced by CRecentFiles().

52 {
53  mpMaxFiles =
54  assertParameter("MaxFiles", CCopasiParameter::UINT, (unsigned C_INT32) 5)->getValue().pUINT;
55  mpRecentFiles = assertGroup("Recent Files");
56 }
CCopasiParameterGroup * mpRecentFiles
unsigned C_INT32 * mpMaxFiles
#define C_INT32
Definition: copasi.h:90
const Value & getValue() const
unsigned C_INT32 * pUINT
CCopasiParameterGroup * assertGroup(const std::string &name)
CCopasiParameter * assertParameter(const std::string &name, const CCopasiParameter::Type type, const CType &defaultValue)

Member Data Documentation

unsigned C_INT32* CRecentFiles::mpMaxFiles
private

A pinter to the maximal number of recent files

Definition at line 75 of file CConfigurationFile.h.

Referenced by addFile(), and initializeParameter().

CCopasiParameterGroup* CRecentFiles::mpRecentFiles
private

A pointer to the list of recent files.

Definition at line 80 of file CConfigurationFile.h.

Referenced by addFile(), and initializeParameter().


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