COPASI API  4.16.103
CLLineEnding.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLLineEnding.h,v $
3 // $Revision: 1.4 $
4 // $Name: $
5 // $Author: shoops $
6 // $Date: 2011/09/30 16:35:21 $
7 // End CVS Header
8 
9 // Copyright (C) 2011 - 2010 by Pedro Mendes, Virginia Tech Intellectual
10 // Properties, Inc., University of Heidelberg, and The University
11 // of Manchester.
12 // All rights reserved.
13 
14 #ifndef CLLineEnding_H__
15 #define CLLineEnding_H__
16 
17 #include <string>
18 
20 #include "copasi/layout/CLGroup.h"
21 #include "copasi/layout/CLBase.h"
23 
24 class LineEnding;
25 
27 {
28 private:
29  // prevent the compiler from generating the assignment operator
30  CLLineEnding& operator=(const CLLineEnding& source);
31 
32 protected:
36 
37  /**
38  * key string for the object.
39  */
40  std::string mKey;
41 
42  /**
43  * The line ending needs an id in addition to the key.
44  * The id corresponds to the id in the SBML render extension and it does not have to
45  * be globally unique. As a matter of fact, it is sometimes needed that line ending of
46  * different render information have the same id.
47  */
48  std::string mId;
49 
50 public:
51  /**
52  * Constructor.
53  */
54  CLLineEnding(CCopasiContainer* pParent = NULL);
55 
56  /**
57  * Copy Constructor.
58  */
59  CLLineEnding(const CLLineEnding& source, CCopasiContainer* pParent = NULL);
60 
61  /**
62  * Constructor to generate object from the corresponding SBML object.
63  */
64  CLLineEnding(const LineEnding& source, CCopasiContainer* pParent = NULL);
65 
66  /**
67  * Sets whether rotational mapping is to be done or not.
68  */
69  void setEnableRotationalMapping(bool enable);
70 
71  /**
72  * Returns whether rotational mapping is enabled or not.
73  */
74  bool getIsEnabledRotationalMapping() const;
75 
76  /**
77  * Sets the bounding box.
78  */
79  void setBoundingBox(const CLBoundingBox* box);
80 
81  /**
82  * Returns the bounding box.
83  */
85 
86  /**
87  * Returns the bounding box.
88  */
89  const CLBoundingBox* getBoundingBox() const;
90 
91  /**
92  * Sets the group.
93  */
94  void setGroup(const CLGroup* group);
95 
96  /**
97  * Returns the group object.
98  */
99  const CLGroup* getGroup() const;
100 
101  /**
102  * Returns the group object.
103  */
104  CLGroup* getGroup();
105 
106  /**
107  * Returns the key string for the line ending.
108  */
109  const std::string& getKey() const;
110 
111  /**
112  * Converts this object to the corresponding SBML object.
113  */
114  LineEnding* toSBML(unsigned int level, unsigned int version) const;
115 
116  /**
117  * Returns the id of the object.
118  */
119  const std::string& getId() const;
120 
121  /**
122  * Sets the id of the object.
123  */
124  void setId(const std::string& id);
125 };
126 
127 #endif /* CLLineEnding_H__ */
void setGroup(const CLGroup *group)
CLLineEnding(CCopasiContainer *pParent=NULL)
void setId(const std::string &id)
std::string mKey
Definition: CLLineEnding.h:40
CLBoundingBox mBoundingBox
Definition: CLLineEnding.h:34
CLGroup * mpGroup
Definition: CLLineEnding.h:35
const CLGroup * getGroup() const
const std::string & getId() const
LineEnding * toSBML(unsigned int level, unsigned int version) const
const std::string & getKey() const
Header file of class CCopasiContainer.
bool mEnableRotationalMapping
Definition: CLLineEnding.h:33
CLLineEnding & operator=(const CLLineEnding &source)
CLBoundingBox * getBoundingBox()
bool getIsEnabledRotationalMapping() const
void setBoundingBox(const CLBoundingBox *box)
std::string mId
Definition: CLLineEnding.h:48
void setEnableRotationalMapping(bool enable)