ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

BinaryFile.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_BINARYFILE_H
47 #define OME_XML_MODEL_BINARYFILE_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/BinData.h>
63 #include <ome/xml/model/External.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/primitives/NonNegativeLong.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class OMEModel;
76
80 class BinaryFile : public detail::OMEModelObject
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 BinaryFile();
90
96 BinaryFile (const BinaryFile& copy);
97
99 virtual
100 ~BinaryFile ();
101
116 static ome::compat::shared_ptr< BinaryFile>
117 create(const common::xml::dom::Element& element,
118 ome::xml::model::OMEModel& model);
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
129 // -- OMEModelObject API methods --
130
132 virtual void
133 update(const common::xml::dom::Element& element,
134 ome::xml::model::OMEModel& model);
135
136 public:
137 // -- BinaryFile API methods --
138
140 bool
141 link (ome::compat::shared_ptr<Reference>& reference,
142 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
143
149 ome::compat::shared_ptr<std::string>
150 getMIMEType ();
151
157 const ome::compat::shared_ptr<std::string>
158 getMIMEType () const;
159
165 void
166 setMIMEType (ome::compat::shared_ptr<std::string>& mimeType);
167
173 const ome::xml::model::primitives::NonNegativeLong&
174 getSize () const;
175
181 void
182 setSize (const ome::xml::model::primitives::NonNegativeLong& size);
183
189 const std::string&
190 getFileName () const;
191
197 void
198 setFileName (const std::string& fileName);
199
205 ome::compat::shared_ptr<ome::xml::model::External>
206 getExternal ();
207
213 const ome::compat::shared_ptr<ome::xml::model::External>
214 getExternal () const;
215
221 void
222 setExternal (ome::compat::shared_ptr<ome::xml::model::External>& external);
223
229 ome::compat::shared_ptr<ome::xml::model::BinData>
230 getBinData ();
231
237 const ome::compat::shared_ptr<ome::xml::model::BinData>
238 getBinData () const;
239
245 void
246 setBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
247
248
250 virtual common::xml::dom::Element
251 asXMLElement (common::xml::dom::Document& document) const;
252
253
254 protected:
255 // Documented in base class.
256 virtual common::xml::dom::Element
257 asXMLElementInternal (common::xml::dom::Document& document,
258 common::xml::dom::Element& element) const;
259
260 public:
261 // Documented in superclass.
262 const std::string&
263 getXMLNamespace() const;
264 };
265
266 }
267 }
268 }
269
270 #endif // OME_XML_MODEL_BINARYFILE_H
271
272 /*
273 * Local Variables:
274 * mode:C++
275 * End:
276 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::BinaryFile::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: BinaryFile.cpp:192
ome::xml::model::BinaryFile::setBinData
void setBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Set the BinData property.
Definition: BinaryFile.cpp:361
ome::xml::model::BinaryFile
BinaryFile model object.
Definition: BinaryFile.h:80
ome::xml::model::BinaryFile::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: BinaryFile.cpp:438
ome::xml::model::BinaryFile::~BinaryFile
virtual ~BinaryFile()
Destructor.
Definition: BinaryFile.cpp:162
ome::xml::model::BinaryFile::getSize
const ome::xml::model::primitives::NonNegativeLong & getSize() const
Get the Size property.
Definition: BinaryFile.cpp:298
ome::xml::model::BinaryFile::getMIMEType
ome::compat::shared_ptr< std::string > getMIMEType()
Get the MIMEType property.
Definition: BinaryFile.cpp:277
ome::xml::model::BinaryFile::Impl
Private implementation details of BinaryFile model object.
Definition: BinaryFile.cpp:75
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::BinaryFile::getBinData
ome::compat::shared_ptr< ome::xml::model::BinData > getBinData()
Get the BinData property.
Definition: BinaryFile.cpp:347
ome::xml::model::BinaryFile::getFileName
const std::string & getFileName() const
Get the FileName property.
Definition: BinaryFile.cpp:312
ome::xml::model::BinaryFile::getExternal
ome::compat::shared_ptr< ome::xml::model::External > getExternal()
Get the External property.
Definition: BinaryFile.cpp:326
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::BinaryFile::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: BinaryFile.cpp:375
ome::xml::model::BinaryFile::setMIMEType
void setMIMEType(ome::compat::shared_ptr< std::string > &mimeType)
Set the MIMEType property.
Definition: BinaryFile.cpp:291
ome::xml::model::BinaryFile::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: BinaryFile.cpp:176
ome::xml::model::BinaryFile::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: BinaryFile.cpp:368
ome::xml::model::BinaryFile::setExternal
void setExternal(ome::compat::shared_ptr< ome::xml::model::External > &external)
Set the External property.
Definition: BinaryFile.cpp:340
ome::xml::model::BinaryFile::setFileName
void setFileName(const std::string &fileName)
Set the FileName property.
Definition: BinaryFile.cpp:319
ome::xml::model::BinaryFile::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: BinaryFile.cpp:262
ome::xml::model::BinaryFile::BinaryFile
BinaryFile()
Default constructor.
Definition: BinaryFile.cpp:143
ome::xml::model::BinaryFile::setSize
void setSize(const ome::xml::model::primitives::NonNegativeLong &size)
Set the Size property.
Definition: BinaryFile.cpp:305
log.h
ome::xml::model::BinaryFile::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: BinaryFile.cpp:183
ome::xml::model::BinaryFile::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: BinaryFile.h:83
ome::xml::model::BinaryFile::create
static ome::compat::shared_ptr< BinaryFile > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a BinaryFile model object from DOM element.
Definition: BinaryFile.cpp:167
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119