ome-xml  5.2.4
Line.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2016 Open Microscopy Environment:
6  * - Massachusetts Institute of Technology
7  * - National Institutes of Health
8  * - University of Dundee
9  * - Board of Regents of the University of Wisconsin-Madison
10  * - Glencoe Software, Inc.
11  * %%
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  * this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright notice,
18  * this list of conditions and the following disclaimer in the documentation
19  * and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * The views and conclusions contained in the software and documentation are
34  * those of the authors and should not be interpreted as representing official
35  * policies, either expressed or implied, of any organization.
36  * #L%
37  */
38 
39 /*─────────────────────────────────────────────────────────────────────────────
40  *
41  * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42  *
43  *─────────────────────────────────────────────────────────────────────────────
44  */
45 
46 #ifndef OME_XML_MODEL_LINE_H
47 #define OME_XML_MODEL_LINE_H
48 
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54 
55 #include <ome/common/log.h>
56 
57 #include <ome/common/xml/dom/Document.h>
58 #include <ome/common/xml/dom/Element.h>
59 #include <ome/common/xml/dom/Node.h>
60 #include <ome/common/xml/dom/NodeList.h>
61 
62 #include <ome/xml/model/primitives/Quantity.h>
63 
64 #include <ome/xml/model/Shape.h>
65 #include <ome/xml/model/enums/Marker.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class OMEModel;
76 
80  class Line : public Shape
81  {
82  private:
83  class Impl;
85  ome::compat::shared_ptr<Impl> impl;
86 
87  public:
89  Line();
90 
96  Line (const Line& copy);
97 
99  virtual
100  ~Line ();
101 
116  static ome::compat::shared_ptr< Line>
117  create(const common::xml::dom::Element& element,
119 
120  // Documented in superclass.
121  const std::string&
122  elementName() const;
123 
124  // Documented in superclass.
125  bool
126  validElementName(const std::string& name) const;
127 
128  private:
130  Line&
131  operator= (const Line&);
132 
133  public:
134  // -- OMEModelObject API methods --
135 
137  virtual void
138  update(const common::xml::dom::Element& element,
140 
141  public:
142  // -- Line API methods --
143 
145  bool
146  link (ome::compat::shared_ptr<Reference>& reference,
147  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
148 
154  double
155  getY2 () const;
156 
162  void
163  setY2 (double y2);
164 
170  double
171  getX2 () const;
172 
178  void
179  setX2 (double x2);
180 
186  ome::compat::shared_ptr<ome::xml::model::enums::Marker>
187  getMarkerEnd ();
188 
194  const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
195  getMarkerEnd () const;
196 
202  void
203  setMarkerEnd (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerEnd);
204 
210  double
211  getY1 () const;
212 
218  void
219  setY1 (double y1);
220 
226  double
227  getX1 () const;
228 
234  void
235  setX1 (double x1);
236 
242  ome::compat::shared_ptr<ome::xml::model::enums::Marker>
243  getMarkerStart ();
244 
250  const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
251  getMarkerStart () const;
252 
258  void
259  setMarkerStart (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerStart);
260 
261  const std::string&
262  getShapeType() const;
263 
266  asXMLElement (common::xml::dom::Document& document) const;
267 
268 
269  protected:
270  // Documented in base class.
273  common::xml::dom::Element& element) const;
274 
275  public:
276  // Documented in superclass.
277  const std::string&
278  getXMLNamespace() const;
279  };
280 
281  }
282  }
283 }
284 
285 #endif // OME_XML_MODEL_LINE_H
286 
287 /*
288  * Local Variables:
289  * mode:C++
290  * End:
291  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Line.cpp:372
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerStart()
Get the MarkerStart property.
Definition: Line.cpp:345
void setY2(double y2)
Set the Y2 property.
Definition: Line.cpp:275
virtual common::xml::dom::Element asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: Line.cpp:379
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Line.h:83
const std::string & elementName() const
Get the element name of this model object.
Definition: Line.cpp:174
static ome::compat::shared_ptr< Line > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Line model object from DOM element.
Definition: Line.cpp:165
void setX2(double x2)
Set the X2 property.
Definition: Line.cpp:289
void setMarkerEnd(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
Set the MarkerEnd property.
Definition: Line.cpp:310
virtual ~Line()
Destructor.
Definition: Line.cpp:160
Line model object.
Definition: Line.h:80
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Line.cpp:181
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerEnd()
Get the MarkerEnd property.
Definition: Line.cpp:296
Private implementation details of Line model object.
Definition: Line.cpp:71
void setMarkerStart(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerStart)
Set the MarkerStart property.
Definition: Line.cpp:359
void setX1(double x1)
Set the X1 property.
Definition: Line.cpp:338
Open Microscopy Environment C++ implementation.
double getX2() const
Get the X2 property.
Definition: Line.cpp:282
bool link(ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Line.cpp:253
const std::string & getShapeType() const
Get the Shape type.
Definition: Line.cpp:365
virtual void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Line.cpp:189
Line & operator=(const Line &)
Assignment operator (deleted).
double getY2() const
Get the Y2 property.
Definition: Line.cpp:268
Shape model object.
Definition: Shape.h:88
double getY1() const
Get the Y1 property.
Definition: Line.cpp:317
void setY1(double y1)
Set the Y1 property.
Definition: Line.cpp:324
Line()
Default constructor.
Definition: Line.cpp:145
double getX1() const
Get the X1 property.
Definition: Line.cpp:331
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Line.cpp:454