ome-xml 5.2.0

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

- File List

Mask.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_MASK_H
47 #define OME_XML_MODEL_MASK_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
64 namespace ome
65 {
66 namespace xml
67 {
68 namespace model
69 {
70
71 // Forward declarations.
72 class BinData;
73 class OMEModel;
74
78 class Mask : public Shape
79 {
80 private:
81 class Impl;
83 ome::compat::shared_ptr<Impl> impl;
84
85 public:
87 Mask();
88
94 Mask (const Mask& copy);
95
97 virtual
98 ~Mask ();
99
114 static ome::compat::shared_ptr< Mask>
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 // -- Mask 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 getY () const;
149
155 void
156 setY (double y);
157
163 double
164 getX () const;
165
171 void
172 setX (double x);
173
179 double
180 getHeight () const;
181
187 void
188 setHeight (double height);
189
195 double
196 getWidth () const;
197
203 void
204 setWidth (double width);
205
211 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
212 sizeOfBinDataList () const;
213
220 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
221 getBinDataList ();
222
229 const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
230 getBinDataList () const;
231
239 ome::compat::shared_ptr<ome::xml::model::BinData>&
240 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);
241
249 const ome::compat::shared_ptr<ome::xml::model::BinData>&
250 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index) const;
251
259 void
260 setBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index,
261 ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
262
271 void
272 addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
273
283 void
284 removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
285
286 const std::string&
287 getShapeType() const;
288
290 virtual common::xml::dom::Element
291 asXMLElement (common::xml::dom::Document& document) const;
292
293
294 protected:
295 // Documented in base class.
296 virtual common::xml::dom::Element
297 asXMLElementInternal (common::xml::dom::Document& document,
298 common::xml::dom::Element& element) const;
299
300 public:
301 // Documented in superclass.
302 const std::string&
303 getXMLNamespace() const;
304 };
305
306 }
307 }
308 }
309
310 #endif // OME_XML_MODEL_MASK_H
311
312 /*
313 * Local Variables:
314 * mode:C++
315 * End:
316 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Mask::getHeight
double getHeight() const
Get the Height property.
Definition: Mask.cpp:294
ome::xml::model::Mask::setY
void setY(double y)
Set the Y property.
Definition: Mask.cpp:273
ome::xml::model::Mask::getX
double getX() const
Get the X property.
Definition: Mask.cpp:280
ome::xml::model::Mask::removeBinData
void removeBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Remove BinData.
Definition: Mask.cpp:369
ome::xml::model::Mask::Impl
Private implementation details of Mask model object.
Definition: Mask.cpp:73
ome::xml::model::Mask::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Mask.h:81
ome::xml::model::Mask::setX
void setX(double x)
Set the X property.
Definition: Mask.cpp:287
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Mask::setBinData
void setBinData(std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Set BinData.
Definition: Mask.cpp:352
ome::xml::model::Mask::addBinData
void addBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Add BinData.
Definition: Mask.cpp:361
ome::xml::model::Mask::getBinDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & getBinDataList()
Get the BinData list.
Definition: Mask.cpp:328
ome::xml::model::Mask::sizeOfBinDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type sizeOfBinDataList() const
Get size of linked BinData list.
Definition: Mask.cpp:322
ome::xml::model::Mask::setWidth
void setWidth(double width)
Set the Width property.
Definition: Mask.cpp:315
ome::xml::model::Mask::create
static ome::compat::shared_ptr< Mask > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Mask model object from DOM element.
Definition: Mask.cpp:165
ome::xml::model::Mask::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: Mask.cpp:190
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Mask
Mask model object.
Definition: Mask.h:78
ome::xml::model::Mask::setHeight
void setHeight(double height)
Set the Height property.
Definition: Mask.cpp:301
ome::xml::model::Mask::getY
double getY() const
Get the Y property.
Definition: Mask.cpp:266
ome::xml::model::Mask::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Mask.cpp:386
ome::xml::model::Mask::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Mask.cpp:174
ome::xml::model::Mask::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: Mask.cpp:393
ome::xml::model::Shape
Shape model object.
Definition: Shape.h:85
ome::xml::model::Mask::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: Mask.cpp:251
ome::xml::model::Mask::~Mask
virtual ~Mask()
Destructor.
Definition: Mask.cpp:160
ome::xml::model::Mask::getShapeType
const std::string & getShapeType() const
Get the Shape type.
Definition: Mask.cpp:379
ome::xml::model::Mask::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Mask.cpp:181
ome::xml::model::Mask::getBinData
ome::compat::shared_ptr< ome::xml::model::BinData > & getBinData(std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index)
Get BinData.
Definition: Mask.cpp:340
ome::xml::model::Mask::Mask
Mask()
Default constructor.
Definition: Mask.cpp:141
log.h
ome::xml::model::Mask::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Mask.cpp:460
ome::xml::model::Mask::getWidth
double getWidth() const
Get the Width property.
Definition: Mask.cpp:308