ome-xml  5.2.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 #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:
81  class Impl;
83  ome::compat::shared_ptr<Impl> impl;
84 
85  public:
87  Line();
88 
94  Line (const Line& copy);
95 
97  virtual
98  ~Line ();
99 
114  static ome::compat::shared_ptr< Line>
115  create(const common::xml::dom::Element& element,
117 
118  // Documented in superclass.
119  const std::string&
120  elementName() const;
121 
122  // Documented in superclass.
123  bool
124  validElementName(const std::string& name) const;
125 
126 
127  // -- OMEModelObject API methods --
128 
130  virtual void
131  update(const common::xml::dom::Element& element,
133 
134  public:
135  // -- Line API methods --
136 
138  bool
139  link (ome::compat::shared_ptr<Reference>& reference,
140  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
141 
147  double
148  getY2 () const;
149 
155  void
156  setY2 (double y2);
157 
163  double
164  getX2 () const;
165 
171  void
172  setX2 (double x2);
173 
179  ome::compat::shared_ptr<ome::xml::model::enums::Marker>
180  getMarkerEnd ();
181 
187  const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
188  getMarkerEnd () const;
189 
195  void
196  setMarkerEnd (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerEnd);
197 
203  double
204  getY1 () const;
205 
211  void
212  setY1 (double y1);
213 
219  double
220  getX1 () const;
221 
227  void
228  setX1 (double x1);
229 
235  ome::compat::shared_ptr<ome::xml::model::enums::Marker>
236  getMarkerStart ();
237 
243  const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
244  getMarkerStart () const;
245 
251  void
252  setMarkerStart (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerStart);
253 
254  const std::string&
255  getShapeType() const;
256 
259  asXMLElement (common::xml::dom::Document& document) const;
260 
261 
262  protected:
263  // Documented in base class.
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: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:186
double getX2() const
Get the X2 property.
Definition: Line.cpp:287
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerStart()
Get the MarkerStart property.
Definition: Line.cpp:350
double getY1() const
Get the Y1 property.
Definition: Line.cpp:322
void setY2(double y2)
Set the Y2 property.
Definition: Line.cpp:280
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Line.h:81
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:170
void setX2(double x2)
Set the X2 property.
Definition: Line.cpp:294
void setMarkerEnd(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
Set the MarkerEnd property.
Definition: Line.cpp:315
virtual ~Line()
Destructor.
Definition: Line.cpp:165
Line model object.
Definition: Line.h:78
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:384
double getY2() const
Get the Y2 property.
Definition: Line.cpp:273
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerEnd()
Get the MarkerEnd property.
Definition: Line.cpp:301
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:364
void setX1(double x1)
Set the X1 property.
Definition: Line.cpp:343
Open Microscopy Environment C++ implementation.
const std::string & elementName() const
Get the element name of this model object.
Definition: Line.cpp:179
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:258
const std::string & getShapeType() const
Get the Shape type.
Definition: Line.cpp:370
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:195
Shape model object.
Definition: Shape.h:85
void setY1(double y1)
Set the Y1 property.
Definition: Line.cpp:329
double getX1() const
Get the X1 property.
Definition: Line.cpp:336
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:377
Line()
Default constructor.
Definition: Line.cpp:146
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Line.cpp:459