ome-xml  5.6.0
Polyline.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_POLYLINE_H
47 #define OME_XML_MODEL_POLYLINE_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 Polyline : public Shape
80  {
81  private:
82  class Impl;
84  std::shared_ptr<Impl> impl;
85 
86  public:
88  Polyline();
89 
95  Polyline (const Polyline& copy);
96 
98  virtual
99  ~Polyline ();
100 
115  static std::shared_ptr<Polyline>
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  Polyline&
129  operator= (const Polyline&) = delete;
131 
132  // -- OMEModelObject API methods --
133 
135  virtual void
136  update(const common::xml::dom::Element& element,
138 
139  public:
140  // -- Polyline API methods --
141 
143  bool
144  link (std::shared_ptr<Reference>& reference,
145  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
146 
152  const std::string&
153  getPoints () const;
154 
160  void
161  setPoints (const std::string& points);
162 
168  std::shared_ptr<ome::xml::model::enums::Marker>
169  getMarkerEnd ();
170 
176  const std::shared_ptr<ome::xml::model::enums::Marker>
177  getMarkerEnd () const;
178 
184  void
185  setMarkerEnd (std::shared_ptr<ome::xml::model::enums::Marker>& markerEnd);
186 
192  std::shared_ptr<ome::xml::model::enums::Marker>
193  getMarkerStart ();
194 
200  const std::shared_ptr<ome::xml::model::enums::Marker>
201  getMarkerStart () const;
202 
208  void
209  setMarkerStart (std::shared_ptr<ome::xml::model::enums::Marker>& markerStart);
210 
211  const std::string&
212  getShapeType() const;
213 
214  protected:
215  // Documented in base class.
216  virtual void
218  common::xml::dom::Element& element) const;
219 
220  public:
221  // Documented in superclass.
222  const std::string&
223  getXMLNamespace() const;
224  };
225 
226  }
227  }
228 }
229 
230 #endif // OME_XML_MODEL_POLYLINE_H
231 
232 /*
233  * Local Variables:
234  * mode:C++
235  * End:
236  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
void setMarkerStart(std::shared_ptr< ome::xml::model::enums::Marker > &markerStart)
Set the MarkerStart property.
Definition: Polyline.cpp:273
Polyline model object.
Definition: Polyline.h:79
std::shared_ptr< ome::xml::model::enums::Marker > getMarkerEnd()
Get the MarkerEnd property.
Definition: Polyline.cpp:238
Private implementation details of Polyline model object.
Definition: Polyline.cpp:71
void setPoints(const std::string &points)
Set the Points property.
Definition: Polyline.cpp:231
std::shared_ptr< ome::xml::model::enums::Marker > getMarkerStart()
Get the MarkerStart property.
Definition: Polyline.cpp:259
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Polyline.h:82
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: Polyline.cpp:286
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Polyline.cpp:168
Open Microscopy Environment C++ implementation.
Polyline()
Default constructor.
Definition: Polyline.cpp:128
static std::shared_ptr< Polyline > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Polyline model object from DOM element.
Definition: Polyline.cpp:152
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: Polyline.cpp:209
Shape model object.
Definition: Shape.h:87
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Polyline.cpp:330
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: Polyline.cpp:174
const std::string & getShapeType() const
Get the Shape type.
Definition: Polyline.cpp:279
const std::string & elementName() const
Get the element name of this model object.
Definition: Polyline.cpp:161
void setMarkerEnd(std::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
Set the MarkerEnd property.
Definition: Polyline.cpp:252
virtual ~Polyline()
Destructor.
Definition: Polyline.cpp:147
const std::string & getPoints() const
Get the Points property.
Definition: Polyline.cpp:224