ome-xml 5.2.3

Plane.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_PLANE_H
47 #define OME_XML_MODEL_PLANE_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/UnitsLength.h>
67 #include <ome/xml/model/enums/UnitsTime.h>
68 #include <ome/xml/model/primitives/NonNegativeInteger.h>
69
70 namespace ome
71 {
72 namespace xml
73 {
74 namespace model
75 {
76
77 // Forward declarations.
78 class Annotation;
79 class OMEModel;
80
84 class Plane : public detail::OMEModelObject
85 {
86 private:
87 class Impl;
89 ome::compat::shared_ptr<Impl> impl;
90
91 public:
93 Plane();
94
100 Plane (const Plane& copy);
101
103 virtual
104 ~Plane ();
105
120 static ome::compat::shared_ptr< Plane>
121 create(const common::xml::dom::Element& element,
122 ome::xml::model::OMEModel& model);
123
124 // Documented in superclass.
125 const std::string&
126 elementName() const;
127
128 // Documented in superclass.
129 bool
130 validElementName(const std::string& name) const;
131
132 private:
134 Plane&
135 operator= (const Plane&);
136
137 public:
138 // -- OMEModelObject API methods --
139
141 virtual void
142 update(const common::xml::dom::Element& element,
143 ome::xml::model::OMEModel& model);
144
145 public:
146 // -- Plane API methods --
147
149 bool
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152
158 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
159 getExposureTime ();
160
166 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
167 getExposureTime () const;
168
174 void
175 setExposureTime (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >& exposureTime);
176
182 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
183 getPositionZ ();
184
190 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
191 getPositionZ () const;
192
198 void
199 setPositionZ (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >& positionZ);
200
206 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
207 getPositionX ();
208
214 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
215 getPositionX () const;
216
222 void
223 setPositionX (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >& positionX);
224
230 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
231 getPositionY ();
232
238 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
239 getPositionY () const;
240
246 void
247 setPositionY (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >& positionY);
248
254 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
255 getDeltaT ();
256
262 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >&
263 getDeltaT () const;
264
270 void
271 setDeltaT (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsTime > >& deltaT);
272
278 const ome::xml::model::primitives::NonNegativeInteger&
279 getTheC () const;
280
286 void
287 setTheC (const ome::xml::model::primitives::NonNegativeInteger& theC);
288
294 const ome::xml::model::primitives::NonNegativeInteger&
295 getTheZ () const;
296
302 void
303 setTheZ (const ome::xml::model::primitives::NonNegativeInteger& theZ);
304
310 const ome::xml::model::primitives::NonNegativeInteger&
311 getTheT () const;
312
318 void
319 setTheT (const ome::xml::model::primitives::NonNegativeInteger& theT);
320
326 ome::compat::shared_ptr<std::string>
327 getHashSHA1 ();
328
334 const ome::compat::shared_ptr<std::string>
335 getHashSHA1 () const;
336
342 void
343 setHashSHA1 (ome::compat::shared_ptr<std::string>& hashSHA1);
344
350 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
351 sizeOfLinkedAnnotationList () const;
352
358 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
359 getLinkedAnnotationList () const;
360
368 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
369 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
370
381 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
382 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
383 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
384
395 bool
396 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
397
413 bool
414 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
415
421 ome::compat::weak_ptr<ome::xml::model::Pixels>
422 getPixels ();
423
429 const ome::compat::weak_ptr<ome::xml::model::Pixels>
430 getPixels () const;
431
437 void
438 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
439
441 virtual common::xml::dom::Element
442 asXMLElement (common::xml::dom::Document& document) const;
443
444
445 protected:
446 // Documented in base class.
447 virtual common::xml::dom::Element
448 asXMLElementInternal (common::xml::dom::Document& document,
449 common::xml::dom::Element& element) const;
450
451 public:
452 // Documented in superclass.
453 const std::string&
454 getXMLNamespace() const;
455 };
456
457 }
458 }
459 }
460
461 #endif // OME_XML_MODEL_PLANE_H
462
463 /*
464 * Local Variables:
465 * mode:C++
466 * End:
467 */
ome::xml::model::Plane::setPixels
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Plane.cpp:644
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Plane::getDeltaT
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getDeltaT()
Get the DeltaT property.
Definition: Plane.cpp:486
ome::xml::model::Plane::getExposureTime
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > & getExposureTime()
Get the ExposureTime property.
Definition: Plane.cpp:402
ome::xml::model::Plane::setExposureTime
void setExposureTime(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &exposureTime)
Set the ExposureTime property.
Definition: Plane.cpp:416
ome::xml::model::Plane::getLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Plane.cpp:582
ome::xml::model::Plane::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Plane.h:87
ome::xml::model::Plane::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: Plane.cpp:657
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::Plane::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: Plane.cpp:371
ome::xml::model::OMEModelObject::indexed_container::type
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
ome::xml::model::Plane::getTheC
const ome::xml::model::primitives::NonNegativeInteger & getTheC() const
Get the TheC property.
Definition: Plane.cpp:507
ome::xml::model::Plane::~Plane
virtual ~Plane()
Destructor.
Definition: Plane.cpp:199
ome::xml::model::Plane::Plane
Plane()
Default constructor.
Definition: Plane.cpp:184
ome::xml::model::Plane::setPositionX
void setPositionX(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionX)
Set the PositionX property.
Definition: Plane.cpp:458
ome::xml::model::Plane::getTheT
const ome::xml::model::primitives::NonNegativeInteger & getTheT() const
Get the TheT property.
Definition: Plane.cpp:535
ome::xml::model::Plane::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: Plane.cpp:228
ome::xml::model::Plane::setTheT
void setTheT(const ome::xml::model::primitives::NonNegativeInteger &theT)
Set the TheT property.
Definition: Plane.cpp:542
ome::xml::model::Plane::setTheZ
void setTheZ(const ome::xml::model::primitives::NonNegativeInteger &theZ)
Set the TheZ property.
Definition: Plane.cpp:528
ome::xml::model::Plane::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Plane.cpp:570
ome::xml::model::Plane::getTheZ
const ome::xml::model::primitives::NonNegativeInteger & getTheZ() const
Get the TheZ property.
Definition: Plane.cpp:521
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::xml::model::Plane::setPositionY
void setPositionY(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionY)
Set the PositionY property.
Definition: Plane.cpp:479
ome::xml::model::Plane::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Plane.cpp:213
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Plane::getHashSHA1
ome::compat::shared_ptr< std::string > getHashSHA1()
Get the HashSHA1 property.
Definition: Plane.cpp:549
ome::xml::model::Plane::Impl
Private implementation details of Plane model object.
Definition: Plane.cpp:75
ome::xml::model::Plane::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plane.cpp:598
ome::xml::model::Plane::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Plane.cpp:220
ome::xml::model::Plane::setPositionZ
void setPositionZ(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionZ)
Set the PositionZ property.
Definition: Plane.cpp:437
ome::xml::model::Plane::getPositionZ
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionZ()
Get the PositionZ property.
Definition: Plane.cpp:423
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::Plane
Plane model object.
Definition: Plane.h:84
ome::xml::model::Plane::getPixels
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Plane.cpp:630
ome::xml::model::Plane::setLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Plane.cpp:588
ome::xml::model::Plane::create
static ome::compat::shared_ptr< Plane > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Plane model object from DOM element.
Definition: Plane.cpp:204
ome::xml::model::Plane::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plane.cpp:612
ome::xml::model::Plane::setHashSHA1
void setHashSHA1(ome::compat::shared_ptr< std::string > &hashSHA1)
Set the HashSHA1 property.
Definition: Plane.cpp:563
ome::xml::model::Plane::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Plane.cpp:650
ome::xml::model::Plane::setDeltaT
void setDeltaT(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsTime > > &deltaT)
Set the DeltaT property.
Definition: Plane.cpp:500
ome::xml::model::Plane::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plane.cpp:798
log.h
ome::xml::model::Plane::setTheC
void setTheC(const ome::xml::model::primitives::NonNegativeInteger &theC)
Set the TheC property.
Definition: Plane.cpp:514
ome::xml::model::Plane::getPositionX
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionX()
Get the PositionX property.
Definition: Plane.cpp:444
ome::xml::model::Plane::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plane.cpp:576
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::Plane::getPositionY
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionY()
Get the PositionY property.
Definition: Plane.cpp:465
ome::xml::model::Plane::operator=
Plane & operator=(const Plane &)
Assignment operator (deleted).