bioformats  5.1.0
Mask.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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:
82  double y;
84  double x;
86  double height;
88  double width;
90  std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> > binDataBlocks;
91 
92  public:
94  Mask ();
95 
101  Mask (const Mask& copy);
102 
104  virtual
105  ~Mask ();
106 
107 
108 
123  static ome::compat::shared_ptr< Mask>
124  create(const common::xml::dom::Element& element,
126 
127  // Documented in superclass.
128  const std::string&
129  elementName() const;
130 
131  // Documented in superclass.
132  bool
133  validElementName(const std::string& name) const;
134 
135 
136  // -- OMEModelObject API methods --
137 
139  virtual void
140  update(const common::xml::dom::Element& element,
142 
143  public:
144  // -- Mask API methods --
145 
147  bool
148  link (ome::compat::shared_ptr<Reference>& reference,
149  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
150 
156  double
157  getY () const;
158 
164  void
165  setY (double y);
166 
172  double
173  getX () const;
174 
180  void
181  setX (double x);
182 
188  double
189  getHeight () const;
190 
196  void
197  setHeight (double height);
198 
204  double
205  getWidth () const;
206 
212  void
213  setWidth (double width);
214 
220  std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
221  sizeOfBinDataList () const;
222 
229  std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
230  getBinDataList ();
231 
238  const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
239  getBinDataList () const;
240 
248  ome::compat::shared_ptr<ome::xml::model::BinData>&
249  getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);
250 
258  const ome::compat::shared_ptr<ome::xml::model::BinData>&
259  getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index) const;
260 
268  void
269  setBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index,
270  ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
271 
280  void
281  addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
282 
292  void
293  removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
294 
295  const std::string&
296  getShapeType() const;
297 
300  asXMLElement (common::xml::dom::Document& document) const;
301 
302 
303  protected:
304  // Documented in base class.
307  common::xml::dom::Element& element) const;
308 
309  public:
310  // Documented in superclass.
311  const std::string&
312  getXMLNamespace() const;
313  };
314 
315  }
316  }
317 }
318 
319 #endif // OME_XML_MODEL_MASK_H
320 
321 /*
322  * Local Variables:
323  * mode:C++
324  * End:
325  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
double getHeight() const
Get the Height property.
Definition: Mask.cpp:271
void setY(double y)
Set the Y property.
Definition: Mask.cpp:250
double getX() const
Get the X property.
Definition: Mask.cpp:257
void removeBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Remove BinData.
Definition: Mask.cpp:346
void setX(double x)
Set the X property.
Definition: Mask.cpp:264
DOM Document wrapper.
Definition: Document.h:80
DOM Element wrapper.
Definition: Element.h:66
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:329
double height
Height property.
Definition: Mask.h:86
void addBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Add BinData.
Definition: Mask.cpp:338
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & getBinDataList()
Get the BinData list.
Definition: Mask.cpp:305
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type sizeOfBinDataList() const
Get size of linked BinData list.
Definition: Mask.cpp:299
void setWidth(double width)
Set the Width property.
Definition: Mask.cpp:292
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:142
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:167
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
double x
X property.
Definition: Mask.h:84
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > binDataBlocks
BinData property (occurs more than once)
Definition: Mask.h:90
Mask model object.
Definition: Mask.h:78
void setHeight(double height)
Set the Height property.
Definition: Mask.cpp:278
double getY() const
Get the Y property.
Definition: Mask.cpp:243
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:363
const std::string & elementName() const
Get the element name of this model object.
Definition: Mask.cpp:151
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:370
Shape model object.
Definition: Shape.h:85
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:228
virtual ~Mask()
Destructor.
Definition: Mask.cpp:137
const std::string & getShapeType() const
Get the Shape type.
Definition: Mask.cpp:356
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Mask.cpp:158
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:317
Mask()
Default constructor.
Definition: Mask.cpp:110
Boost.Log compatibility.
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Mask.cpp:437
double y
Y property.
Definition: Mask.h:82
double getWidth() const
Get the Width property.
Definition: Mask.cpp:285
double width
Width property.
Definition: Mask.h:88
Xerces-C modern C++ wrapper.
Definition: Base.h:53