ome-xml  5.6.0
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 
61 #include <ome/xml/model/primitives/Quantity.h>
62 
63 #include <ome/xml/model/Shape.h>
64 #include <ome/xml/model/enums/Marker.h>
65 
66 namespace ome
67 {
68  namespace xml
69  {
70  namespace model
71  {
72 
73  // Forward declarations.
74  class OMEModel;
75 
79  class Line : public Shape
80  {
81  private:
82  class Impl;
84  std::shared_ptr<Impl> impl;
85 
86  public:
88  Line();
89 
95  Line (const Line& copy);
96 
98  virtual
99  ~Line ();
100 
115  static std::shared_ptr<Line>
116  create(const common::xml::dom::Element& element,
118 
119  // Documented in superclass.
120  const std::string&
121  elementName() const;
122 
123  // Documented in superclass.
124  bool
125  validElementName(const std::string& name) const;
126 
128  Line&
129  operator= (const Line&) = delete;
131 
132  // -- OMEModelObject API methods --
133 
135  virtual void
136  update(const common::xml::dom::Element& element,
138 
139  public:
140  // -- Line API methods --
141 
143  bool
144  link (std::shared_ptr<Reference>& reference,
145  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
146 
152  double
153  getY2 () const;
154 
160  void
161  setY2 (double y2);
162 
168  double
169  getX2 () const;
170 
176  void
177  setX2 (double x2);
178 
184  std::shared_ptr<ome::xml::model::enums::Marker>
185  getMarkerEnd ();
186 
192  const std::shared_ptr<ome::xml::model::enums::Marker>
193  getMarkerEnd () const;
194 
200  void
201  setMarkerEnd (std::shared_ptr<ome::xml::model::enums::Marker>& markerEnd);
202 
208  double
209  getY1 () const;
210 
216  void
217  setY1 (double y1);
218 
224  double
225  getX1 () const;
226 
232  void
233  setX1 (double x1);
234 
240  std::shared_ptr<ome::xml::model::enums::Marker>
241  getMarkerStart ();
242 
248  const std::shared_ptr<ome::xml::model::enums::Marker>
249  getMarkerStart () const;
250 
256  void
257  setMarkerStart (std::shared_ptr<ome::xml::model::enums::Marker>& markerStart);
258 
259  const std::string&
260  getShapeType() const;
261 
262  protected:
263  // Documented in base class.
264  virtual void
266  common::xml::dom::Element& element) const;
267 
268  public:
269  // Documented in superclass.
270  const std::string&
271  getXMLNamespace() const;
272  };
273 
274  }
275  }
276 }
277 
278 #endif // OME_XML_MODEL_LINE_H
279 
280 /*
281  * Local Variables:
282  * mode:C++
283  * End:
284  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
void setY2(double y2)
Set the Y2 property.
Definition: Line.cpp:281
virtual void 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:378
const std::string & elementName() const
Get the element name of this model object.
Definition: Line.cpp:182
void setX2(double x2)
Set the X2 property.
Definition: Line.cpp:295
virtual ~Line()
Destructor.
Definition: Line.cpp:168
Line model object.
Definition: Line.h:79
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Line.cpp:189
Private implementation details of Line model object.
Definition: Line.cpp:71
std::shared_ptr< ome::xml::model::enums::Marker > getMarkerStart()
Get the MarkerStart property.
Definition: Line.cpp:351
void setX1(double x1)
Set the X1 property.
Definition: Line.cpp:344
void setMarkerEnd(std::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
Set the MarkerEnd property.
Definition: Line.cpp:316
Open Microscopy Environment C++ implementation.
double getX2() const
Get the X2 property.
Definition: Line.cpp:288
std::shared_ptr< ome::xml::model::enums::Marker > getMarkerEnd()
Get the MarkerEnd property.
Definition: Line.cpp:302
static std::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:173
const std::string & getShapeType() const
Get the Shape type.
Definition: Line.cpp:371
virtual SKIP 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:195
void setMarkerStart(std::shared_ptr< ome::xml::model::enums::Marker > &markerStart)
Set the MarkerStart property.
Definition: Line.cpp:365
double getY2() const
Get the Y2 property.
Definition: Line.cpp:274
Shape model object.
Definition: Shape.h:87
double getY1() const
Get the Y1 property.
Definition: Line.cpp:323
void setY1(double y1)
Set the Y1 property.
Definition: Line.cpp:330
Line()
Default constructor.
Definition: Line.cpp:149
double getX1() const
Get the X1 property.
Definition: Line.cpp:337
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Line.cpp:443
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Line.cpp:259
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Line.h:82