bioformats  5.1.3
Line.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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/Shape.h>
63 #include <ome/xml/model/enums/Marker.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class OMEModel;
74 
78  class Line : public Shape
79  {
80  private:
82  double y2;
84  double x2;
86  ome::compat::shared_ptr<ome::xml::model::enums::Marker> markerEnd;
88  double y1;
90  double x1;
92  ome::compat::shared_ptr<ome::xml::model::enums::Marker> markerStart;
93 
94  public:
96  Line ();
97 
103  Line (const Line& copy);
104 
106  virtual
107  ~Line ();
108 
109 
110 
125  static ome::compat::shared_ptr< Line>
126  create(const common::xml::dom::Element& element,
128 
129  // Documented in superclass.
130  const std::string&
131  elementName() const;
132 
133  // Documented in superclass.
134  bool
135  validElementName(const std::string& name) const;
136 
137 
138  // -- OMEModelObject API methods --
139 
141  virtual void
142  update(const common::xml::dom::Element& element,
144 
145  public:
146  // -- Line API methods --
147 
149  bool
150  link (ome::compat::shared_ptr<Reference>& reference,
151  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152 
158  double
159  getY2 () const;
160 
166  void
167  setY2 (double y2);
168 
174  double
175  getX2 () const;
176 
182  void
183  setX2 (double x2);
184 
190  ome::compat::shared_ptr<ome::xml::model::enums::Marker>
191  getMarkerEnd ();
192 
198  const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
199  getMarkerEnd () const;
200 
206  void
207  setMarkerEnd (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerEnd);
208 
214  double
215  getY1 () const;
216 
222  void
223  setY1 (double y1);
224 
230  double
231  getX1 () const;
232 
238  void
239  setX1 (double x1);
240 
246  ome::compat::shared_ptr<ome::xml::model::enums::Marker>
247  getMarkerStart ();
248 
254  const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
255  getMarkerStart () const;
256 
262  void
263  setMarkerStart (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerStart);
264 
265  const std::string&
266  getShapeType() const;
267 
270  asXMLElement (common::xml::dom::Document& document) const;
271 
272 
273  protected:
274  // Documented in base class.
277  common::xml::dom::Element& element) const;
278 
279  public:
280  // Documented in superclass.
281  const std::string&
282  getXMLNamespace() const;
283  };
284 
285  }
286  }
287 }
288 
289 #endif // OME_XML_MODEL_LINE_H
290 
291 /*
292  * Local Variables:
293  * mode:C++
294  * End:
295  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Line.cpp:161
double y2
Y2 property.
Definition: Line.h:82
double getX2() const
Get the X2 property.
Definition: Line.cpp:262
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerStart()
Get the MarkerStart property.
Definition: Line.cpp:325
double getY1() const
Get the Y1 property.
Definition: Line.cpp:297
void setY2(double y2)
Set the Y2 property.
Definition: Line.cpp:255
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:145
double y1
Y1 property.
Definition: Line.h:88
void setX2(double x2)
Set the X2 property.
Definition: Line.cpp:269
void setMarkerEnd(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
Set the MarkerEnd property.
Definition: Line.cpp:290
virtual ~Line()
Destructor.
Definition: Line.cpp:140
Line model object.
Definition: Line.h:78
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
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:359
double getY2() const
Get the Y2 property.
Definition: Line.cpp:248
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerEnd()
Get the MarkerEnd property.
Definition: Line.cpp:276
void setMarkerStart(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerStart)
Set the MarkerStart property.
Definition: Line.cpp:339
void setX1(double x1)
Set the X1 property.
Definition: Line.cpp:318
ome::compat::shared_ptr< ome::xml::model::enums::Marker > markerEnd
MarkerEnd property.
Definition: Line.h:86
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
const std::string & elementName() const
Get the element name of this model object.
Definition: Line.cpp:154
double x2
X2 property.
Definition: Line.h:84
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:233
const std::string & getShapeType() const
Get the Shape type.
Definition: Line.cpp:345
ome::compat::shared_ptr< ome::xml::model::enums::Marker > markerStart
MarkerStart property.
Definition: Line.h:92
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:170
double x1
X1 property.
Definition: Line.h:90
Shape model object.
Definition: Shape.h:85
void setY1(double y1)
Set the Y1 property.
Definition: Line.cpp:304
double getX1() const
Get the X1 property.
Definition: Line.cpp:311
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:352
Line()
Default constructor.
Definition: Line.cpp:111
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Line.cpp:434
Boost.Log compatibility.
Xerces-C modern C++ wrapper.
Definition: Base.h:53