ome-xml 5.2.3

TiffData.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_TIFFDATA_H
47 #define OME_XML_MODEL_TIFFDATA_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/UUID.h>
66 #include <ome/xml/model/detail/OMEModelObject.h>
67 #include <ome/xml/model/primitives/NonNegativeInteger.h>
68
69 namespace ome
70 {
71 namespace xml
72 {
73 namespace model
74 {
75
76 // Forward declarations.
77 class OMEModel;
78
82 class TiffData : public detail::OMEModelObject
83 {
84 private:
85 class Impl;
87 ome::compat::shared_ptr<Impl> impl;
88
89 public:
91 TiffData();
92
98 TiffData (const TiffData& copy);
99
101 virtual
102 ~TiffData ();
103
118 static ome::compat::shared_ptr< TiffData>
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 TiffData&
133 operator= (const TiffData&);
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 // -- TiffData 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 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
157 getIFD ();
158
164 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
165 getIFD () const;
166
172 void
173 setIFD (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& ifd);
174
180 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
181 getPlaneCount ();
182
188 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
189 getPlaneCount () const;
190
196 void
197 setPlaneCount (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& planeCount);
198
204 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
205 getFirstZ ();
206
212 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
213 getFirstZ () const;
214
220 void
221 setFirstZ (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& firstZ);
222
228 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
229 getFirstC ();
230
236 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
237 getFirstC () const;
238
244 void
245 setFirstC (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& firstC);
246
252 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
253 getFirstT ();
254
260 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
261 getFirstT () const;
262
268 void
269 setFirstT (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& firstT);
270
276 ome::compat::shared_ptr<ome::xml::model::UUID>
277 getUUID ();
278
284 const ome::compat::shared_ptr<ome::xml::model::UUID>
285 getUUID () const;
286
292 void
293 setUUID (ome::compat::shared_ptr<ome::xml::model::UUID>& uuid);
294
300 ome::compat::weak_ptr<ome::xml::model::Pixels>
301 getPixels ();
302
308 const ome::compat::weak_ptr<ome::xml::model::Pixels>
309 getPixels () const;
310
316 void
317 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
318
320 virtual common::xml::dom::Element
321 asXMLElement (common::xml::dom::Document& document) const;
322
323
324 protected:
325 // Documented in base class.
326 virtual common::xml::dom::Element
327 asXMLElementInternal (common::xml::dom::Document& document,
328 common::xml::dom::Element& element) const;
329
330 public:
331 // Documented in superclass.
332 const std::string&
333 getXMLNamespace() const;
334 };
335
336 }
337 }
338 }
339
340 #endif // OME_XML_MODEL_TIFFDATA_H
341
342 /*
343 * Local Variables:
344 * mode:C++
345 * End:
346 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::TiffData::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: TiffData.h:85
ome::xml::model::TiffData::getUUID
ome::compat::shared_ptr< ome::xml::model::UUID > getUUID()
Get the UUID property.
Definition: TiffData.cpp:392
ome::xml::model::TiffData::getFirstT
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFirstT()
Get the FirstT property.
Definition: TiffData.cpp:371
ome::xml::model::TiffData
TiffData model object.
Definition: TiffData.h:82
ome::xml::model::TiffData::TiffData
TiffData()
Default constructor.
Definition: TiffData.cpp:153
ome::xml::model::TiffData::setIFD
void setIFD(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &ifd)
Set the IFD property.
Definition: TiffData.cpp:301
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::TiffData::~TiffData
virtual ~TiffData()
Destructor.
Definition: TiffData.cpp:168
ome::xml::model::TiffData::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: TiffData.cpp:440
ome::xml::model::TiffData::setPixels
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: TiffData.cpp:427
ome::xml::model::TiffData::setFirstZ
void setFirstZ(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstZ)
Set the FirstZ property.
Definition: TiffData.cpp:343
ome::xml::model::TiffData::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: TiffData.cpp:433
ome::xml::model::TiffData::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: TiffData.cpp:197
ome::xml::model::TiffData::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: TiffData.cpp:189
ome::xml::model::TiffData::getFirstZ
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFirstZ()
Get the FirstZ property.
Definition: TiffData.cpp:329
ome::xml::model::TiffData::getPlaneCount
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getPlaneCount()
Get the PlaneCount property.
Definition: TiffData.cpp:308
ome::xml::model::TiffData::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: TiffData.cpp:526
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::TiffData::Impl
Private implementation details of TiffData model object.
Definition: TiffData.cpp:72
ome::xml::model::TiffData::setUUID
void setUUID(ome::compat::shared_ptr< ome::xml::model::UUID > &uuid)
Set the UUID property.
Definition: TiffData.cpp:406
ome::xml::model::TiffData::operator=
TiffData & operator=(const TiffData &)
Assignment operator (deleted).
ome::xml::model::TiffData::setFirstT
void setFirstT(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstT)
Set the FirstT property.
Definition: TiffData.cpp:385
ome::xml::model::TiffData::getFirstC
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFirstC()
Get the FirstC property.
Definition: TiffData.cpp:350
ome::xml::model::TiffData::getPixels
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: TiffData.cpp:413
ome::xml::model::TiffData::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: TiffData.cpp:182
ome::xml::model::TiffData::setFirstC
void setFirstC(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstC)
Set the FirstC property.
Definition: TiffData.cpp:364
ome::xml::model::TiffData::setPlaneCount
void setPlaneCount(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &planeCount)
Set the PlaneCount property.
Definition: TiffData.cpp:322
ome::xml::model::TiffData::create
static ome::compat::shared_ptr< TiffData > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a TiffData model object from DOM element.
Definition: TiffData.cpp:173
log.h
ome::xml::model::TiffData::getIFD
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getIFD()
Get the IFD property.
Definition: TiffData.cpp:287
ome::xml::model::TiffData::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: TiffData.cpp:272