ome-xml  5.2.2
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/primitives/Quantity.h>
63 
64 #include <ome/xml/model/BinData.h>
65 #include <ome/xml/model/Shape.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class OMEModel;
76 
80  class Mask : public Shape
81  {
82  private:
83  class Impl;
85  ome::compat::shared_ptr<Impl> impl;
86 
87  public:
89  Mask();
90 
96  Mask (const Mask& copy);
97 
99  virtual
100  ~Mask ();
101 
116  static ome::compat::shared_ptr< Mask>
117  create(const common::xml::dom::Element& element,
119 
120  // Documented in superclass.
121  const std::string&
122  elementName() const;
123 
124  // Documented in superclass.
125  bool
126  validElementName(const std::string& name) const;
127 
128  private:
130  Mask&
131  operator= (const Mask&);
132 
133  public:
134  // -- OMEModelObject API methods --
135 
137  virtual void
138  update(const common::xml::dom::Element& element,
140 
141  public:
142  // -- Mask API methods --
143 
145  bool
146  link (ome::compat::shared_ptr<Reference>& reference,
147  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
148 
154  double
155  getY () const;
156 
162  void
163  setY (double y);
164 
170  double
171  getX () const;
172 
178  void
179  setX (double x);
180 
186  double
187  getHeight () const;
188 
194  void
195  setHeight (double height);
196 
202  double
203  getWidth () const;
204 
210  void
211  setWidth (double width);
212 
218  ome::compat::shared_ptr<ome::xml::model::BinData>
219  getBinData ();
220 
226  const ome::compat::shared_ptr<ome::xml::model::BinData>
227  getBinData () const;
228 
234  void
235  setBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
236 
237  const std::string&
238  getShapeType() const;
239 
242  asXMLElement (common::xml::dom::Document& document) const;
243 
244 
245  protected:
246  // Documented in base class.
249  common::xml::dom::Element& element) const;
250 
251  public:
252  // Documented in superclass.
253  const std::string&
254  getXMLNamespace() const;
255  };
256 
257  }
258  }
259 }
260 
261 #endif // OME_XML_MODEL_MASK_H
262 
263 /*
264  * Local Variables:
265  * mode:C++
266  * End:
267  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
double getHeight() const
Get the Height property.
Definition: Mask.cpp:297
void setBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Set the BinData property.
Definition: Mask.cpp:339
void setY(double y)
Set the Y property.
Definition: Mask.cpp:276
double getX() const
Get the X property.
Definition: Mask.cpp:283
Private implementation details of Mask model object.
Definition: Mask.cpp:73
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Mask.h:83
void setX(double x)
Set the X property.
Definition: Mask.cpp:290
void setWidth(double width)
Set the Width property.
Definition: Mask.cpp:318
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:164
ome::compat::shared_ptr< ome::xml::model::BinData > getBinData()
Get the BinData property.
Definition: Mask.cpp:325
Mask & operator=(const Mask &)
Assignment operator (deleted).
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:188
Open Microscopy Environment C++ implementation.
Mask model object.
Definition: Mask.h:80
void setHeight(double height)
Set the Height property.
Definition: Mask.cpp:304
double getY() const
Get the Y property.
Definition: Mask.cpp:269
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:352
const std::string & elementName() const
Get the element name of this model object.
Definition: Mask.cpp:173
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:359
Shape model object.
Definition: Shape.h:88
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:254
virtual ~Mask()
Destructor.
Definition: Mask.cpp:159
const std::string & getShapeType() const
Get the Shape type.
Definition: Mask.cpp:345
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Mask.cpp:180
Mask()
Default constructor.
Definition: Mask.cpp:140
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Mask.cpp:419
double getWidth() const
Get the Width property.
Definition: Mask.cpp:311