ome-xml 5.2.0

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

- File List

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/Pixels.h>
63 #include <ome/xml/model/UUID.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/primitives/NonNegativeInteger.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class OMEModel;
76
80 class TiffData : public detail::OMEModelObject
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 TiffData();
90
96 TiffData (const TiffData& copy);
97
99 virtual
100 ~TiffData ();
101
116 static ome::compat::shared_ptr< TiffData>
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 // -- TiffData 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<ome::xml::model::primitives::NonNegativeInteger>
150 getIFD ();
151
157 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
158 getIFD () const;
159
165 void
166 setIFD (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& ifd);
167
173 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
174 getPlaneCount ();
175
181 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
182 getPlaneCount () const;
183
189 void
190 setPlaneCount (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& planeCount);
191
197 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
198 getFirstZ ();
199
205 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
206 getFirstZ () const;
207
213 void
214 setFirstZ (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& firstZ);
215
221 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
222 getFirstC ();
223
229 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
230 getFirstC () const;
231
237 void
238 setFirstC (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& firstC);
239
245 ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
246 getFirstT ();
247
253 const ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>
254 getFirstT () const;
255
261 void
262 setFirstT (ome::compat::shared_ptr<ome::xml::model::primitives::NonNegativeInteger>& firstT);
263
269 ome::compat::shared_ptr<ome::xml::model::UUID>
270 getUUID ();
271
277 const ome::compat::shared_ptr<ome::xml::model::UUID>
278 getUUID () const;
279
285 void
286 setUUID (ome::compat::shared_ptr<ome::xml::model::UUID>& uuid);
287
293 ome::compat::weak_ptr<ome::xml::model::Pixels>
294 getPixels ();
295
301 const ome::compat::weak_ptr<ome::xml::model::Pixels>
302 getPixels () const;
303
309 void
310 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
311
312
314 virtual common::xml::dom::Element
315 asXMLElement (common::xml::dom::Document& document) const;
316
317
318 protected:
319 // Documented in base class.
320 virtual common::xml::dom::Element
321 asXMLElementInternal (common::xml::dom::Document& document,
322 common::xml::dom::Element& element) const;
323
324 public:
325 // Documented in superclass.
326 const std::string&
327 getXMLNamespace() const;
328 };
329
330 }
331 }
332 }
333
334 #endif // OME_XML_MODEL_TIFFDATA_H
335
336 /*
337 * Local Variables:
338 * mode:C++
339 * End:
340 */
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:83
ome::xml::model::TiffData::getUUID
ome::compat::shared_ptr< ome::xml::model::UUID > getUUID()
Get the UUID property.
Definition: TiffData.cpp:397
ome::xml::model::TiffData::getFirstT
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFirstT()
Get the FirstT property.
Definition: TiffData.cpp:376
ome::xml::model::TiffData
TiffData model object.
Definition: TiffData.h:80
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:194
ome::xml::model::TiffData::TiffData
TiffData()
Default constructor.
Definition: TiffData.cpp:154
ome::xml::model::TiffData::setIFD
void setIFD(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &ifd)
Set the IFD property.
Definition: TiffData.cpp:306
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:173
ome::xml::model::TiffData::setPixels
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: TiffData.cpp:432
ome::xml::model::TiffData::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: TiffData.cpp:532
ome::xml::model::TiffData::setFirstZ
void setFirstZ(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstZ)
Set the FirstZ property.
Definition: TiffData.cpp:348
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:446
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:203
ome::xml::model::TiffData::getFirstZ
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFirstZ()
Get the FirstZ property.
Definition: TiffData.cpp:334
ome::xml::model::TiffData::getPlaneCount
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getPlaneCount()
Get the PlaneCount property.
Definition: TiffData.cpp:313
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:411
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:439
ome::xml::model::TiffData::setFirstT
void setFirstT(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstT)
Set the FirstT property.
Definition: TiffData.cpp:390
ome::xml::model::TiffData::getFirstC
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getFirstC()
Get the FirstC property.
Definition: TiffData.cpp:355
ome::xml::model::TiffData::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: TiffData.cpp:187
ome::xml::model::TiffData::getPixels
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: TiffData.cpp:418
ome::xml::model::TiffData::setFirstC
void setFirstC(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &firstC)
Set the FirstC property.
Definition: TiffData.cpp:369
ome::xml::model::TiffData::setPlaneCount
void setPlaneCount(ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > &planeCount)
Set the PlaneCount property.
Definition: TiffData.cpp:327
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:178
log.h
ome::xml::model::TiffData::getIFD
ome::compat::shared_ptr< ome::xml::model::primitives::NonNegativeInteger > getIFD()
Get the IFD property.
Definition: TiffData.cpp:292
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:277