ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

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 #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 Polyline : public Shape
79 {
80 private:
81 class Impl;
83 ome::compat::shared_ptr<Impl> impl;
84
85 public:
87 Polyline();
88
94 Polyline (const Polyline& copy);
95
97 virtual
98 ~Polyline ();
99
114 static ome::compat::shared_ptr< Polyline>
115 create(const common::xml::dom::Element& element,
116 ome::xml::model::OMEModel& model);
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,
132 ome::xml::model::OMEModel& model);
133
134 public:
135 // -- Polyline 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 const std::string&
148 getPoints () const;
149
155 void
156 setPoints (const std::string& points);
157
163 ome::compat::shared_ptr<ome::xml::model::enums::Marker>
164 getMarkerEnd ();
165
171 const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
172 getMarkerEnd () const;
173
179 void
180 setMarkerEnd (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerEnd);
181
187 ome::compat::shared_ptr<ome::xml::model::enums::Marker>
188 getMarkerStart ();
189
195 const ome::compat::shared_ptr<ome::xml::model::enums::Marker>
196 getMarkerStart () const;
197
203 void
204 setMarkerStart (ome::compat::shared_ptr<ome::xml::model::enums::Marker>& markerStart);
205
206 const std::string&
207 getShapeType() const;
208
210 virtual common::xml::dom::Element
211 asXMLElement (common::xml::dom::Document& document) const;
212
213
214 protected:
215 // Documented in base class.
216 virtual common::xml::dom::Element
217 asXMLElementInternal (common::xml::dom::Document& document,
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::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Polyline::getShapeType
const std::string & getShapeType() const
Get the Shape type.
Definition: Polyline.cpp:278
ome::xml::model::Polyline
Polyline model object.
Definition: Polyline.h:78
ome::xml::model::Polyline::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Polyline.cpp:340
ome::xml::model::Polyline::setMarkerEnd
void setMarkerEnd(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerEnd)
Set the MarkerEnd property.
Definition: Polyline.cpp:251
ome::xml::model::Polyline::Impl
Private implementation details of Polyline model object.
Definition: Polyline.cpp:71
ome::xml::model::Polyline::setPoints
void setPoints(const std::string &points)
Set the Points property.
Definition: Polyline.cpp:230
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Polyline::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Polyline.cpp:158
ome::xml::model::Polyline::getMarkerEnd
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerEnd()
Get the MarkerEnd property.
Definition: Polyline.cpp:237
ome::xml::model::Polyline::getMarkerStart
ome::compat::shared_ptr< ome::xml::model::enums::Marker > getMarkerStart()
Get the MarkerStart property.
Definition: Polyline.cpp:258
ome::xml::model::Polyline::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Polyline.h:81
ome::xml::model::Polyline::getPoints
const std::string & getPoints() const
Get the Points property.
Definition: Polyline.cpp:223
ome::xml::model::Polyline::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Polyline.cpp:285
ome::xml::model::Polyline::create
static ome::compat::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:149
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Polyline::Polyline
Polyline()
Default constructor.
Definition: Polyline.cpp:125
ome::xml::model::Shape
Shape model object.
Definition: Shape.h:85
ome::xml::model::Polyline::update
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: Polyline.cpp:174
ome::xml::model::Polyline::asXMLElementInternal
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: Polyline.cpp:292
ome::xml::model::Polyline::setMarkerStart
void setMarkerStart(ome::compat::shared_ptr< ome::xml::model::enums::Marker > &markerStart)
Set the MarkerStart property.
Definition: Polyline.cpp:272
ome::xml::model::Polyline::~Polyline
virtual ~Polyline()
Destructor.
Definition: Polyline.cpp:144
ome::xml::model::Polyline::link
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: Polyline.cpp:208
log.h
ome::xml::model::Polyline::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Polyline.cpp:165