ome-xml 5.2.0

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

- File List

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/Pixels.h>
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 #include <ome/xml/model/primitives/NonNegativeInteger.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class Annotation;
75 class OMEModel;
76
80 class Plane : public detail::OMEModelObject
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 Plane();
90
96 Plane (const Plane& copy);
97
99 virtual
100 ~Plane ();
101
116 static ome::compat::shared_ptr< Plane>
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 // -- Plane 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<double>
150 getExposureTime ();
151
157 const ome::compat::shared_ptr<double>
158 getExposureTime () const;
159
165 void
166 setExposureTime (ome::compat::shared_ptr<double>& exposureTime);
167
173 ome::compat::shared_ptr<double>
174 getPositionZ ();
175
181 const ome::compat::shared_ptr<double>
182 getPositionZ () const;
183
189 void
190 setPositionZ (ome::compat::shared_ptr<double>& positionZ);
191
197 ome::compat::shared_ptr<double>
198 getPositionX ();
199
205 const ome::compat::shared_ptr<double>
206 getPositionX () const;
207
213 void
214 setPositionX (ome::compat::shared_ptr<double>& positionX);
215
221 ome::compat::shared_ptr<double>
222 getPositionY ();
223
229 const ome::compat::shared_ptr<double>
230 getPositionY () const;
231
237 void
238 setPositionY (ome::compat::shared_ptr<double>& positionY);
239
245 ome::compat::shared_ptr<double>
246 getDeltaT ();
247
253 const ome::compat::shared_ptr<double>
254 getDeltaT () const;
255
261 void
262 setDeltaT (ome::compat::shared_ptr<double>& deltaT);
263
269 const ome::xml::model::primitives::NonNegativeInteger&
270 getTheC () const;
271
277 void
278 setTheC (const ome::xml::model::primitives::NonNegativeInteger& theC);
279
285 const ome::xml::model::primitives::NonNegativeInteger&
286 getTheZ () const;
287
293 void
294 setTheZ (const ome::xml::model::primitives::NonNegativeInteger& theZ);
295
301 const ome::xml::model::primitives::NonNegativeInteger&
302 getTheT () const;
303
309 void
310 setTheT (const ome::xml::model::primitives::NonNegativeInteger& theT);
311
317 ome::compat::shared_ptr<std::string>
318 getHashSHA1 ();
319
325 const ome::compat::shared_ptr<std::string>
326 getHashSHA1 () const;
327
333 void
334 setHashSHA1 (ome::compat::shared_ptr<std::string>& hashSHA1);
335
341 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
342 sizeOfLinkedAnnotationList () const;
343
349 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
350 getLinkedAnnotationList () const;
351
359 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
360 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
361
372 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
373 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
374 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
375
386 bool
387 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
388
404 bool
405 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
406
412 ome::compat::weak_ptr<ome::xml::model::Pixels>
413 getPixels ();
414
420 const ome::compat::weak_ptr<ome::xml::model::Pixels>
421 getPixels () const;
422
428 void
429 setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
430
431
433 virtual common::xml::dom::Element
434 asXMLElement (common::xml::dom::Document& document) const;
435
436
437 protected:
438 // Documented in base class.
439 virtual common::xml::dom::Element
440 asXMLElementInternal (common::xml::dom::Document& document,
441 common::xml::dom::Element& element) const;
442
443 public:
444 // Documented in superclass.
445 const std::string&
446 getXMLNamespace() const;
447 };
448
449 }
450 }
451 }
452
453 #endif // OME_XML_MODEL_PLANE_H
454
455 /*
456 * Local Variables:
457 * mode:C++
458 * End:
459 */
ome::xml::model::Plane::setPixels
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Plane.cpp:617
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Plane::getPositionZ
ome::compat::shared_ptr< double > getPositionZ()
Get the PositionZ property.
Definition: Plane.cpp:396
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:555
ome::xml::model::Plane::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Plane.h:83
ome::xml::model::Plane::getPositionY
ome::compat::shared_ptr< double > getPositionY()
Get the PositionY property.
Definition: Plane.cpp:438
ome::xml::model::Plane::getDeltaT
ome::compat::shared_ptr< double > getDeltaT()
Get the DeltaT property.
Definition: Plane.cpp:459
ome::xml::model::Plane::setDeltaT
void setDeltaT(ome::compat::shared_ptr< double > &deltaT)
Set the DeltaT property.
Definition: Plane.cpp:473
ome::xml::model::Plane::getExposureTime
ome::compat::shared_ptr< double > getExposureTime()
Get the ExposureTime property.
Definition: Plane.cpp:375
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::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plane.cpp:549
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:344
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::~Plane
virtual ~Plane()
Destructor.
Definition: Plane.cpp:202
ome::xml::model::Plane::setPositionX
void setPositionX(ome::compat::shared_ptr< double > &positionX)
Set the PositionX property.
Definition: Plane.cpp:431
ome::xml::model::Plane::Plane
Plane()
Default constructor.
Definition: Plane.cpp:183
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:232
ome::xml::model::Plane::setTheT
void setTheT(const ome::xml::model::primitives::NonNegativeInteger &theT)
Set the TheT property.
Definition: Plane.cpp:515
ome::xml::model::Plane::setTheZ
void setTheZ(const ome::xml::model::primitives::NonNegativeInteger &theZ)
Set the TheZ property.
Definition: Plane.cpp:501
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::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:631
ome
Open Microscopy Environment C++ implementation.
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:624
ome::xml::model::Plane::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plane.cpp:772
ome::xml::model::Plane::setPositionY
void setPositionY(ome::compat::shared_ptr< double > &positionY)
Set the PositionY property.
Definition: Plane.cpp:452
ome::xml::model::Plane::getHashSHA1
ome::compat::shared_ptr< std::string > getHashSHA1()
Get the HashSHA1 property.
Definition: Plane.cpp:522
ome::xml::model::Plane::getTheT
const ome::xml::model::primitives::NonNegativeInteger & getTheT() const
Get the TheT property.
Definition: Plane.cpp:508
ome::xml::model::Plane::Impl
Private implementation details of Plane model object.
Definition: Plane.cpp:73
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:543
ome::xml::model::Plane::getTheC
const ome::xml::model::primitives::NonNegativeInteger & getTheC() const
Get the TheC property.
Definition: Plane.cpp:480
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:223
ome::xml::model::Plane::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plane.cpp:571
ome::xml::model::Plane::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Plane.cpp:216
ome::xml::model::Plane::getPositionX
ome::compat::shared_ptr< double > getPositionX()
Get the PositionX property.
Definition: Plane.cpp:417
ome::xml::model::Plane::getTheZ
const ome::xml::model::primitives::NonNegativeInteger & getTheZ() const
Get the TheZ property.
Definition: Plane.cpp:494
ome::xml::model::Plane
Plane model object.
Definition: Plane.h:80
ome::xml::model::Plane::getPixels
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Plane.cpp:603
ome::xml::model::Plane::setPositionZ
void setPositionZ(ome::compat::shared_ptr< double > &positionZ)
Set the PositionZ property.
Definition: Plane.cpp:410
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:561
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:207
ome::xml::model::Plane::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plane.cpp:585
ome::xml::model::Plane::setHashSHA1
void setHashSHA1(ome::compat::shared_ptr< std::string > &hashSHA1)
Set the HashSHA1 property.
Definition: Plane.cpp:536
ome::xml::model::Plane::setExposureTime
void setExposureTime(ome::compat::shared_ptr< double > &exposureTime)
Set the ExposureTime property.
Definition: Plane.cpp:389
log.h
ome::xml::model::Plane::setTheC
void setTheC(const ome::xml::model::primitives::NonNegativeInteger &theC)
Set the TheC property.
Definition: Plane.cpp:487
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119