COPASI API  4.16.103
CLEllipse.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLEllipse.h,v $
3 // $Revision: 1.5 $
4 // $Name: $
5 // $Author: shoops $
6 // $Date: 2011/09/30 16:35:20 $
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 CLEllipse_H__
15 #define CLEllipse_H__
16 
17 #include <string>
18 
22 
23 class CCopasiContainer;
24 class sbmlEllipse;
25 
27 {
28 private:
29  // prevent the compiler from generating the assignment operator
30  CLEllipse& operator=(const CLEllipse& source);
31 
32 protected:
38 
39  /**
40  * key for the object.
41  */
42  std::string mKey;
43 
44 public:
45  /**
46  * Constructor.
47  */
48  CLEllipse(CCopasiContainer* pParent = NULL);
49 
50  /**
51  * Constructor with 2D center and radius.
52  */
53  CLEllipse(const CLRelAbsVector& cx, const CLRelAbsVector& cy, const CLRelAbsVector& r, CCopasiContainer* pParent = NULL);
54 
55  /**
56  * Constructor with 2D center and radii.
57  */
58  CLEllipse(const CLRelAbsVector& cx, const CLRelAbsVector& cy, const CLRelAbsVector& rx, const CLRelAbsVector& ry, CCopasiContainer* pParent = NULL);
59 
60  /**
61  * Constructor with 3D center and radii.
62  */
63  CLEllipse(const CLRelAbsVector& cx, const CLRelAbsVector& cy, const CLRelAbsVector& cz, const CLRelAbsVector& rx, const CLRelAbsVector& ry, CCopasiContainer* pParent = NULL);
64 
65  /**
66  * Copy Constructor
67  */
68  CLEllipse(const CLEllipse& source, CCopasiContainer* pParent = NULL);
69 
70  /**
71  * Constructor to generate object from the corresponding SBML object.
72  */
73  CLEllipse(const sbmlEllipse& source, CCopasiContainer* pParent = NULL);
74 
75  /**
76  * Destructor.
77  */
78  ~CLEllipse();
79 
80  /**
81  * Returns the x component of the center.
82  */
83  const CLRelAbsVector& getCX() const;
84 
85  /**
86  * Returns the y component of the center.
87  */
88  const CLRelAbsVector& getCY() const;
89 
90  /**
91  * Returns the z component of the center.
92  */
93  const CLRelAbsVector& getCZ() const;
94 
95  /**
96  * Returns the radius along the x axis.
97  */
98  const CLRelAbsVector& getRX() const;
99 
100  /**
101  * Returns the radius along the y axis.
102  */
103  const CLRelAbsVector& getRY() const;
104 
105  /**
106  * Returns the x component of the center.
107  */
109 
110  /**
111  * Returns the y component of the center.
112  */
114 
115  /**
116  * Returns the z component of the center.
117  */
119 
120  /**
121  * Returns the radius along the x axis.
122  */
124 
125  /**
126  * Returns the radius along the y axis.
127  */
129 
130  /**
131  * Sets the x component of the center.
132  */
133  void setCX(const CLRelAbsVector& cx);
134 
135  /**
136  * Sets the y component of the center.
137  */
138  void setCY(const CLRelAbsVector& cy);
139 
140  /**
141  * Sets the z component of the center.
142  */
143  void setCZ(const CLRelAbsVector& cz);
144 
145  /**
146  * Sets the radius along the x axis.
147  */
148  void setRX(const CLRelAbsVector& rx);
149 
150  /**
151  * Sets the radius along the y axis.
152  */
153  void setRY(const CLRelAbsVector& ry);
154 
155  /**
156  * Sets the 2D center.
157  */
158  void setCenter2D(const CLRelAbsVector& cx, const CLRelAbsVector& cy);
159 
160  /**
161  * Sets the 3D center.
162  */
163  void setCenter3D(const CLRelAbsVector& cx, const CLRelAbsVector& cy, const CLRelAbsVector& cz);
164 
165  /**
166  * Sets the radii.
167  */
168  void setRadii(const CLRelAbsVector& rx, const CLRelAbsVector& ry);
169 
170  /**
171  * Returns the key string of the object.
172  */
173  const std::string& getKey() const;
174 
175  /**
176  * Converts this object to the corresponding SBML object.
177  */
178  sbmlEllipse* toSBML(unsigned int level, unsigned int version) const;
179 };
180 
181 #endif /* CLEllipse_H__ */
void setCX(const CLRelAbsVector &cx)
Definition: CLEllipse.cpp:207
CLRelAbsVector mRX
Definition: CLEllipse.h:36
void setCZ(const CLRelAbsVector &cz)
Definition: CLEllipse.cpp:223
CLRelAbsVector mCX
Definition: CLEllipse.h:33
CLEllipse & operator=(const CLEllipse &source)
const CLRelAbsVector & getRX() const
Definition: CLEllipse.cpp:151
const CLRelAbsVector & getCY() const
Definition: CLEllipse.cpp:135
std::string mKey
Definition: CLEllipse.h:42
const std::string & getKey() const
Definition: CLEllipse.cpp:276
void setRadii(const CLRelAbsVector &rx, const CLRelAbsVector &ry)
Definition: CLEllipse.cpp:267
#define sbmlEllipse
Definition: CLEllipse.cpp:18
CLRelAbsVector mCY
Definition: CLEllipse.h:34
void setRX(const CLRelAbsVector &rx)
Definition: CLEllipse.cpp:231
sbmlEllipse * toSBML(unsigned int level, unsigned int version) const
Definition: CLEllipse.cpp:284
const CLRelAbsVector & getCZ() const
Definition: CLEllipse.cpp:143
CLRelAbsVector mRY
Definition: CLEllipse.h:37
const CLRelAbsVector & getRY() const
Definition: CLEllipse.cpp:159
CLRelAbsVector mCZ
Definition: CLEllipse.h:35
void setCY(const CLRelAbsVector &cy)
Definition: CLEllipse.cpp:215
CLEllipse(CCopasiContainer *pParent=NULL)
Definition: CLEllipse.cpp:27
void setRY(const CLRelAbsVector &ry)
Definition: CLEllipse.cpp:239
void setCenter3D(const CLRelAbsVector &cx, const CLRelAbsVector &cy, const CLRelAbsVector &cz)
Definition: CLEllipse.cpp:257
const CLRelAbsVector & getCX() const
Definition: CLEllipse.cpp:127
void setCenter2D(const CLRelAbsVector &cx, const CLRelAbsVector &cy)
Definition: CLEllipse.cpp:247