COPASI API  4.16.103
CLImage.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLImage.h,v $
3 // $Revision: 1.4 $
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 CLImage_H__
15 #define CLImage_H__
16 
17 #include <string>
18 
22 
23 class CCopasiContainer;
24 class Image;
25 
27 {
28 private:
29  // prevent the compiler from generating the assignment operator
30  CLImage& operator=(const CLImage& source);
31 
32 protected:
38  std::string mHRef;
39 
40  /**
41  * key for the object.
42  */
43  std::string mKey;
44 
45 public:
46  /**
47  * Constructor.
48  */
49  CLImage(CCopasiContainer* pParent = NULL);
50 
51  /**
52  * Copy Constructor.
53  */
54  CLImage(const CLImage& source, CCopasiContainer* pParent = NULL);
55 
56  /**
57  * Constructor to generate object from the corresponding SBML object.
58  */
59  CLImage(const Image& source, CCopasiContainer* pParent = NULL);
60 
61  /**
62  * Destructor.
63  */
64  ~CLImage();
65 
66  /**
67  * Sets the coordinates.
68  */
69  void setCoordinates(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z = CLRelAbsVector(0.0, 0.0));
70 
71  /**
72  * Sets the x coordinate.
73  */
74  void setX(const CLRelAbsVector& coord);
75 
76  /**
77  * Sets the y coordinate.
78  */
79  void setY(const CLRelAbsVector& coord);
80 
81  /**
82  * Sets the z coordinate.
83  */
84  void setZ(const CLRelAbsVector& coord);
85 
86  /**
87  * Returns the x coordinate.
88  */
90 
91  /**
92  * Returns the y coordinate.
93  */
95 
96  /**
97  * Returns the z coordinate.
98  */
100 
101  /**
102  * Returns the x coordinate.
103  */
104  const CLRelAbsVector& getX() const;
105 
106  /**
107  * Returns the y coordinate.
108  */
109  const CLRelAbsVector& getY() const;
110 
111  /**
112  * Returns the z coordinate.
113  */
114  const CLRelAbsVector& getZ() const;
115 
116  /**
117  * Sets the dimensions.
118  */
119  void setDimensions(const CLRelAbsVector& width, const CLRelAbsVector& height);
120 
121  /**
122  * Sets the width.
123  */
124  void setWidth(const CLRelAbsVector& width);
125 
126  /**
127  * Sets the height.
128  */
129  void setHeight(const CLRelAbsVector& height);
130 
131  /**
132  * Returns the width.
133  */
134  const CLRelAbsVector& getWidth() const;
135 
136  /**
137  * Returns the height.
138  */
139  const CLRelAbsVector& getHeight() const;
140 
141  /**
142  * Sets the reference to the image location.
143  */
144  void setImageReference(const std::string& ref);
145 
146  /**
147  * Returns the image reference.
148  */
149  const std::string& getImageReference() const;
150 
151  /**
152  * Returns true if the image reference has been set.
153  */
154  bool isSetImageReference() const;
155 
156  /**
157  * Returns the key string of the object.
158  */
159  const std::string& getKey() const;
160 
161  /**
162  * Converts this object to the corresponding SBML object.
163  */
164  Image* toSBML(unsigned int level, unsigned int version) const;
165 };
166 
167 #endif /* CLImage_H__ */
CLRelAbsVector & getX()
Definition: CLImage.cpp:198
const std::string & getKey() const
Definition: CLImage.cpp:232
CLImage(CCopasiContainer *pParent=NULL)
Definition: CLImage.cpp:24
CLRelAbsVector mY
Definition: CLImage.h:34
const CLRelAbsVector & getHeight() const
Definition: CLImage.cpp:116
CLRelAbsVector & getY()
Definition: CLImage.cpp:206
~CLImage()
Definition: CLImage.cpp:75
void setZ(const CLRelAbsVector &coord)
Definition: CLImage.cpp:166
const std::string & getImageReference() const
Definition: CLImage.cpp:132
std::string mKey
Definition: CLImage.h:43
CLImage & operator=(const CLImage &source)
void setImageReference(const std::string &ref)
Definition: CLImage.cpp:124
void setY(const CLRelAbsVector &coord)
Definition: CLImage.cpp:158
void setWidth(const CLRelAbsVector &width)
Definition: CLImage.cpp:92
Image * toSBML(unsigned int level, unsigned int version) const
Definition: CLImage.cpp:240
CLRelAbsVector mZ
Definition: CLImage.h:35
const CLRelAbsVector & getWidth() const
Definition: CLImage.cpp:108
void setX(const CLRelAbsVector &coord)
Definition: CLImage.cpp:150
CLRelAbsVector & getZ()
Definition: CLImage.cpp:214
bool isSetImageReference() const
Definition: CLImage.cpp:222
CLRelAbsVector mHeight
Definition: CLImage.h:37
void setHeight(const CLRelAbsVector &height)
Definition: CLImage.cpp:100
void setCoordinates(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z=CLRelAbsVector(0.0, 0.0))
Definition: CLImage.cpp:140
CLRelAbsVector mWidth
Definition: CLImage.h:36
void setDimensions(const CLRelAbsVector &width, const CLRelAbsVector &height)
Definition: CLImage.cpp:83
CLRelAbsVector mX
Definition: CLImage.h:33
std::string mHRef
Definition: CLImage.h:38