ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Pixels.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66 #include <ome/xml/model/enums/Compression.h>
67 #include <ome/xml/model/primitives/NonNegativeLong.h>
68
69 namespace ome
70 {
71 namespace xml
72 {
73 namespace model
74 {
75
76 // Forward declarations.
77 class OMEModel;
78
82 class BinData : public detail::OMEModelObject
83 {
84 private:
85 class Impl;
87 ome::compat::shared_ptr<Impl> impl;
88
89 public:
91 BinData();
92
98 BinData (const BinData& copy);
99
101 virtual
102 ~BinData ();
103
118 static ome::compat::shared_ptr< BinData>
119 create(const common::xml::dom::Element& element,
120 ome::xml::model::OMEModel& model);
121
122 // Documented in superclass.
123 const std::string&
124 elementName() const;
125
126 // Documented in superclass.
127 bool
128 validElementName(const std::string& name) const;
129
130 private:
132 BinData&
133 operator= (const BinData&);
134
135 public:
136 // -- OMEModelObject API methods --
137
139 virtual void
140 update(const common::xml::dom::Element& element,
141 ome::xml::model::OMEModel& model);
142
143 public:
144 // -- BinData 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 const std::vector<uint8_t>&
157 getBase64Binary () const;
158
164 void
165 setBase64Binary (const std::vector<uint8_t>& base64Binary);
166
172 bool
173 getBigEndian () const;
174
180 void
181 setBigEndian (bool bigEndian);
182
188 const ome::xml::model::primitives::NonNegativeLong&
189 getLength () const;
190
196 void
197 setLength (const ome::xml::model::primitives::NonNegativeLong& length);
198
204 ome::compat::shared_ptr<ome::xml::model::enums::Compression>
205 getCompression ();
206
212 const ome::compat::shared_ptr<ome::xml::model::enums::Compression>
213 getCompression () const;
214
220 void
221 setCompression (ome::compat::shared_ptr<ome::xml::model::enums::Compression>& compression);
222
228 ome::compat::weak_ptr<ome::xml::model::Pixels>
229 getPixels ();
230
236 const ome::compat::weak_ptr<ome::xml::model::Pixels>
237 getPixels () const;
238
244 void
245 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
246
248 virtual common::xml::dom::Element
249 asXMLElement (common::xml::dom::Document& document) const;
250
251
252 protected:
253 // Documented in base class.
254 virtual common::xml::dom::Element
255 asXMLElementInternal (common::xml::dom::Document& document,
256 common::xml::dom::Element& element) const;
257
258 public:
259 // Documented in superclass.
260 const std::string&
261 getXMLNamespace() const;
262 };
263
264 }
265 }
266 }
267
268 #endif // OME_XML_MODEL_BINDATA_H
269
270 /*
271 * Local Variables:
272 * mode:C++
273 * End:
274 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::BinData::setBigEndian
void setBigEndian(bool bigEndian)
Set the BigEndian property.
Definition: BinData.cpp:267
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::BinData::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: BinData.h:85
ome::xml::model::BinData::Impl
Private implementation details of BinData model object.
Definition: BinData.cpp:73
ome::xml::model::BinData::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: BinData.cpp:184
ome::xml::model::BinData::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: BinData.cpp:176
ome::xml::model::BinData::~BinData
virtual ~BinData()
Destructor.
Definition: BinData.cpp:155
ome::xml::model::BinData::getPixels
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: BinData.cpp:309
ome::xml::model::BinData::BinData
BinData()
Default constructor.
Definition: BinData.cpp:140
ome::xml::model::BinData::asXMLElement
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:329
ome::xml::model::BinData::getCompression
ome::compat::shared_ptr< ome::xml::model::enums::Compression > getCompression()
Get the Compression property.
Definition: BinData.cpp:288
ome::xml::model::BinData::setLength
void setLength(const ome::xml::model::primitives::NonNegativeLong &length)
Set the Length property.
Definition: BinData.cpp:281
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::BinData::operator=
BinData & operator=(const BinData &)
Assignment operator (deleted).
ome::xml::model::BinData::create
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:160
ome::xml::model::BinData::getLength
const ome::xml::model::primitives::NonNegativeLong & getLength() const
Get the Length property.
Definition: BinData.cpp:274
ome::xml::model::BinData::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: BinData.cpp:169
ome::xml::model::BinData::setPixels
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: BinData.cpp:323
ome::xml::model::BinData::getBigEndian
bool getBigEndian() const
Get the BigEndian property.
Definition: BinData.cpp:260
ome::xml::model::BinData::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: BinData.cpp:390
ome::xml::model::BinData
BinData model object.
Definition: BinData.h:82
ome::xml::model::BinData::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: BinData.cpp:231
ome::xml::model::BinData::getBase64Binary
const std::vector< uint8_t > & getBase64Binary() const
Get the Base64Binary property.
Definition: BinData.cpp:246
log.h
ome::xml::model::BinData::setCompression
void setCompression(ome::compat::shared_ptr< ome::xml::model::enums::Compression > &compression)
Set the Compression property.
Definition: BinData.cpp:302
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
ome::xml::model::BinData::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: BinData.cpp:336
ome::xml::model::BinData::setBase64Binary
void setBase64Binary(const std::vector< uint8_t > &base64Binary)
Set the Base64Binary property.
Definition: BinData.cpp:253