bioformats  5.1.0
BinData.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_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:
85  bool bigEndian;
89  ome::compat::shared_ptr<ome::xml::model::enums::Compression> compression;
91  ome::compat::weak_ptr<ome::xml::model::Pixels> pixels;
93  ome::compat::weak_ptr<ome::xml::model::Mask> mask;
94 
95  public:
97  BinData ();
98 
104  BinData (const BinData& copy);
105 
107  virtual
108  ~BinData ();
109 
110 
111 
126  static ome::compat::shared_ptr< BinData>
127  create(const common::xml::dom::Element& element,
129 
130  // Documented in superclass.
131  const std::string&
132  elementName() const;
133 
134  // Documented in superclass.
135  bool
136  validElementName(const std::string& name) const;
137 
138 
139  // -- OMEModelObject API methods --
140 
142  virtual void
143  update(const common::xml::dom::Element& element,
145 
146  public:
147  // -- BinData API methods --
148 
150  bool
151  link (ome::compat::shared_ptr<Reference>& reference,
152  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
153 
159  bool
160  getBigEndian () const;
161 
167  void
168  setBigEndian (bool bigEndian);
169 
176  getLength () const;
177 
183  void
185 
191  ome::compat::shared_ptr<ome::xml::model::enums::Compression>
192  getCompression ();
193 
199  const ome::compat::shared_ptr<ome::xml::model::enums::Compression>
200  getCompression () const;
201 
207  void
208  setCompression (ome::compat::shared_ptr<ome::xml::model::enums::Compression>& compression);
209 
215  ome::compat::weak_ptr<ome::xml::model::Pixels>
216  getPixels ();
217 
223  const ome::compat::weak_ptr<ome::xml::model::Pixels>
224  getPixels () const;
225 
231  void
232  setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
233 
239  ome::compat::weak_ptr<ome::xml::model::Mask>
240  getMask ();
241 
247  const ome::compat::weak_ptr<ome::xml::model::Mask>
248  getMask () const;
249 
255  void
256  setMask (ome::compat::weak_ptr<ome::xml::model::Mask>& mask_BackReference);
257 
258 
261  asXMLElement (common::xml::dom::Document& document) const;
262 
263 
264  protected:
265  // Documented in base class.
268  common::xml::dom::Element& element) const;
269 
270  public:
271  // Documented in superclass.
272  const std::string&
273  getXMLNamespace() const;
274  };
275 
276  }
277  }
278 }
279 
280 #endif // OME_XML_MODEL_BINDATA_H
281 
282 /*
283  * Local Variables:
284  * mode:C++
285  * End:
286  */
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:367
ome::compat::weak_ptr< ome::xml::model::Mask > getMask()
Get the Mask property.
Definition: BinData.cpp:290
ome::xml::model::primitives::NonNegativeLong length
Length property.
Definition: BinData.h:87
void setBigEndian(bool bigEndian)
Set the BigEndian property.
Definition: BinData.cpp:227
const ome::xml::model::primitives::NonNegativeLong & getLength() const
Get the Length property.
Definition: BinData.cpp:234
DOM Document wrapper.
Definition: Document.h:80
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:318
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void setMask(ome::compat::weak_ptr< ome::xml::model::Mask > &mask_BackReference)
Set the Mask property.
Definition: BinData.cpp:304
bool getBigEndian() const
Get the BigEndian property.
Definition: BinData.cpp:220
bool bigEndian
BigEndian property.
Definition: BinData.h:85
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:167
virtual ~BinData()
Destructor.
Definition: BinData.cpp:137
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: BinData.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: BinData.cpp:311
BinData()
Default constructor.
Definition: BinData.cpp:110
ome::compat::weak_ptr< ome::xml::model::Pixels > pixels
Pixels_BackReference back reference.
Definition: BinData.h:91
ome::compat::shared_ptr< ome::xml::model::enums::Compression > getCompression()
Get the Compression property.
Definition: BinData.cpp:248
void setLength(const ome::xml::model::primitives::NonNegativeLong &length)
Set the Length property.
Definition: BinData.cpp:241
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
ome::compat::shared_ptr< ome::xml::model::enums::Compression > compression
Compression property.
Definition: BinData.h:89
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:142
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: BinData.cpp:158
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: BinData.cpp:283
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:205
ome::compat::weak_ptr< ome::xml::model::Mask > mask
Mask_BackReference back reference.
Definition: BinData.h:93
const std::string & elementName() const
Get the element name of this model object.
Definition: BinData.cpp:151
Boost.Log compatibility.
void setCompression(ome::compat::shared_ptr< ome::xml::model::enums::Compression > &compression)
Set the Compression property.
Definition: BinData.cpp:262
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
Xerces-C modern C++ wrapper.
Definition: Base.h:53