ome-xml  5.2.0
BinData.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_BINDATA_H
47 #define OME_XML_MODEL_BINDATA_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/Mask.h>
63 #include <ome/xml/model/Pixels.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/enums/Compression.h>
66 #include <ome/xml/model/primitives/NonNegativeLong.h>
67 
68 namespace ome
69 {
70  namespace xml
71  {
72  namespace model
73  {
74 
75  // Forward declarations.
76  class OMEModel;
77 
82  {
83  private:
84  class Impl;
86  ome::compat::shared_ptr<Impl> impl;
87 
88  public:
90  BinData();
91 
97  BinData (const BinData& copy);
98 
100  virtual
101  ~BinData ();
102 
117  static ome::compat::shared_ptr< BinData>
118  create(const common::xml::dom::Element& element,
120 
121  // Documented in superclass.
122  const std::string&
123  elementName() const;
124 
125  // Documented in superclass.
126  bool
127  validElementName(const std::string& name) const;
128 
129 
130  // -- OMEModelObject API methods --
131 
133  virtual void
134  update(const common::xml::dom::Element& element,
136 
137  public:
138  // -- BinData API methods --
139 
141  bool
142  link (ome::compat::shared_ptr<Reference>& reference,
143  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144 
150  bool
151  getBigEndian () const;
152 
158  void
159  setBigEndian (bool bigEndian);
160 
167  getLength () const;
168 
174  void
176 
182  ome::compat::shared_ptr<ome::xml::model::enums::Compression>
183  getCompression ();
184 
190  const ome::compat::shared_ptr<ome::xml::model::enums::Compression>
191  getCompression () const;
192 
198  void
199  setCompression (ome::compat::shared_ptr<ome::xml::model::enums::Compression>& compression);
200 
206  ome::compat::weak_ptr<ome::xml::model::Pixels>
207  getPixels ();
208 
214  const ome::compat::weak_ptr<ome::xml::model::Pixels>
215  getPixels () const;
216 
222  void
223  setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
224 
230  ome::compat::weak_ptr<ome::xml::model::Mask>
231  getMask ();
232 
238  const ome::compat::weak_ptr<ome::xml::model::Mask>
239  getMask () const;
240 
246  void
247  setMask (ome::compat::weak_ptr<ome::xml::model::Mask>& mask_BackReference);
248 
249 
252  asXMLElement (common::xml::dom::Document& document) const;
253 
254 
255  protected:
256  // Documented in base class.
259  common::xml::dom::Element& element) const;
260 
261  public:
262  // Documented in superclass.
263  const std::string&
264  getXMLNamespace() const;
265  };
266 
267  }
268  }
269 }
270 
271 #endif // OME_XML_MODEL_BINDATA_H
272 
273 /*
274  * Local Variables:
275  * mode:C++
276  * End:
277  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: BinData.cpp:390
ome::compat::weak_ptr< ome::xml::model::Mask > getMask()
Get the Mask property.
Definition: BinData.cpp:313
void setBigEndian(bool bigEndian)
Set the BigEndian property.
Definition: BinData.cpp:250
const ome::xml::model::primitives::NonNegativeLong & getLength() const
Get the Length property.
Definition: BinData.cpp:257
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: BinData.cpp:341
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: BinData.h:84
void setMask(ome::compat::weak_ptr< ome::xml::model::Mask > &mask_BackReference)
Set the Mask property.
Definition: BinData.cpp:327
Private implementation details of BinData model object.
Definition: BinData.cpp:73
bool getBigEndian() const
Get the BigEndian property.
Definition: BinData.cpp:243
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: BinData.cpp:190
virtual ~BinData()
Destructor.
Definition: BinData.cpp:160
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: BinData.cpp:292
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: BinData.cpp:334
BinData()
Default constructor.
Definition: BinData.cpp:141
ome::compat::shared_ptr< ome::xml::model::enums::Compression > getCompression()
Get the Compression property.
Definition: BinData.cpp:271
void setLength(const ome::xml::model::primitives::NonNegativeLong &length)
Set the Length property.
Definition: BinData.cpp:264
Open Microscopy Environment C++ implementation.
static ome::compat::shared_ptr< BinData > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a BinData model object from DOM element.
Definition: BinData.cpp:165
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: BinData.cpp:181
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: BinData.cpp:306
BinData model object.
Definition: BinData.h:81
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: BinData.cpp:228
const std::string & elementName() const
Get the element name of this model object.
Definition: BinData.cpp:174
void setCompression(ome::compat::shared_ptr< ome::xml::model::enums::Compression > &compression)
Set the Compression property.
Definition: BinData.cpp:285
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119