COPASI API  4.16.103
CListOfLayouts.h
Go to the documentation of this file.
1 // Copyright (C) 2010 - 2013 by Pedro Mendes, Virginia Tech Intellectual
2 // Properties, Inc., University of Heidelberg, and The University
3 // of Manchester.
4 // All rights reserved.
5 
6 // Copyright (C) 2008 - 2009 by Pedro Mendes, Virginia Tech Intellectual
7 // Properties, Inc., EML Research, gGmbH, University of Heidelberg,
8 // and The University of Manchester.
9 // All rights reserved.
10 
11 // Copyright (C) 2007 by Pedro Mendes, Virginia Tech Intellectual
12 // Properties, Inc. and EML Research, gGmbH.
13 // All rights reserved.
14 
15 #ifndef LOLAYOUT_H
16 #define LOLAYOUT_H
17 
19 #include "CLayout.h"
20 
22 
23 class ListOf;
24 
25 /**
26  * this class stores a list of layouts. It should also keep the maps
27  * that translate from sbml IDs to COPASI keys
28  */
29 class CListOfLayouts : public CCopasiVector<CLayout>
30 {
31 private:
32  std::string mKey;
33 
35 
36 public:
37  CListOfLayouts(const std::string & name = "ListOfLayouts",
38  const CCopasiContainer* pParent = NULL);
39 
41 
42  const std::string& getKey();
43 
44  /**
45  * Add a layout to the list.
46  * At the moment the map is just ignored. Later it should be stored somewhere
47  */
48  void addLayout(CLayout * layout, const std::map<std::string, std::string> & m);
49 
50  /**
51  * This method writes the information of the copasi layout object into the
52  * corresponding sbml object.
53  * copasimodelmap maps the copasi model objects to libsbml objects.
54  * At the moment we donĀ“t assume layout objects are in the copasimodelmap.
55  * idSet should contain all sbml IDs that are used in the currently exported
56  * model (including the layouts, but not the objects inside the layout).
57  */
58  void exportToSBML(ListOf * lol, std::map<const CCopasiObject*, SBase*> & copasimodelmap,
59  const std::map<std::string, const SBase*>& idMap, unsigned int level, unsigned int version) const;
60 
61  //*******************
62 
64  {return this->mvGlobalRenderInformationObjects;};
65 
67  {return this->mvGlobalRenderInformationObjects;};
68 
69  /**
70  * add local render information to layout. The layout takes ownership of the object.
71  */
73 
74  /**
75  * Returns a pointer to the global render information object with the given index.
76  * If the index is invalid, NULL is returned.
77  */
79 
80  /**
81  * Returns a const pointer to the global render information object with the given index.
82  * If the index is invalid, NULL is returned.
83  */
84  const CLGlobalRenderInformation* getRenderInformation(size_t index) const;
85 };
86 
87 #endif
std::string mKey
void exportToSBML(ListOf *lol, std::map< const CCopasiObject *, SBase * > &copasimodelmap, const std::map< std::string, const SBase * > &idMap, unsigned int level, unsigned int version) const
CCopasiVector< CLGlobalRenderInformation > & getListOfGlobalRenderInformationObjects()
void addGlobalRenderInformation(CLGlobalRenderInformation *pRenderInfo)
CCopasiVector< CLGlobalRenderInformation > mvGlobalRenderInformationObjects
CListOfLayouts(const std::string &name="ListOfLayouts", const CCopasiContainer *pParent=NULL)
void addLayout(CLayout *layout, const std::map< std::string, std::string > &m)
CLGlobalRenderInformation * getRenderInformation(size_t index)
const std::string & getKey()
const CCopasiVector< CLGlobalRenderInformation > & getListOfGlobalRenderInformationObjects() const