bioformats  5.1.0
Plane.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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 
81  {
82  private:
84  ome::compat::shared_ptr<double> exposureTime;
86  ome::compat::shared_ptr<double> positionZ;
88  ome::compat::shared_ptr<double> positionX;
90  ome::compat::shared_ptr<double> positionY;
92  ome::compat::shared_ptr<double> deltaT;
100  ome::compat::shared_ptr<std::string> hashSHA1;
104  ome::compat::weak_ptr<ome::xml::model::Pixels> pixels;
105 
106  public:
108  Plane ();
109 
115  Plane (const Plane& copy);
116 
118  virtual
119  ~Plane ();
120 
121 
122 
137  static ome::compat::shared_ptr< Plane>
138  create(const common::xml::dom::Element& element,
140 
141  // Documented in superclass.
142  const std::string&
143  elementName() const;
144 
145  // Documented in superclass.
146  bool
147  validElementName(const std::string& name) const;
148 
149 
150  // -- OMEModelObject API methods --
151 
153  virtual void
154  update(const common::xml::dom::Element& element,
156 
157  public:
158  // -- Plane API methods --
159 
161  bool
162  link (ome::compat::shared_ptr<Reference>& reference,
163  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
164 
170  ome::compat::shared_ptr<double>
171  getExposureTime ();
172 
178  const ome::compat::shared_ptr<double>
179  getExposureTime () const;
180 
186  void
187  setExposureTime (ome::compat::shared_ptr<double>& exposureTime);
188 
194  ome::compat::shared_ptr<double>
195  getPositionZ ();
196 
202  const ome::compat::shared_ptr<double>
203  getPositionZ () const;
204 
210  void
211  setPositionZ (ome::compat::shared_ptr<double>& positionZ);
212 
218  ome::compat::shared_ptr<double>
219  getPositionX ();
220 
226  const ome::compat::shared_ptr<double>
227  getPositionX () const;
228 
234  void
235  setPositionX (ome::compat::shared_ptr<double>& positionX);
236 
242  ome::compat::shared_ptr<double>
243  getPositionY ();
244 
250  const ome::compat::shared_ptr<double>
251  getPositionY () const;
252 
258  void
259  setPositionY (ome::compat::shared_ptr<double>& positionY);
260 
266  ome::compat::shared_ptr<double>
267  getDeltaT ();
268 
274  const ome::compat::shared_ptr<double>
275  getDeltaT () const;
276 
282  void
283  setDeltaT (ome::compat::shared_ptr<double>& deltaT);
284 
291  getTheC () const;
292 
298  void
300 
307  getTheZ () const;
308 
314  void
316 
323  getTheT () const;
324 
330  void
332 
338  ome::compat::shared_ptr<std::string>
339  getHashSHA1 ();
340 
346  const ome::compat::shared_ptr<std::string>
347  getHashSHA1 () const;
348 
354  void
355  setHashSHA1 (ome::compat::shared_ptr<std::string>& hashSHA1);
356 
364 
371  getLinkedAnnotationList () const;
372 
380  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
382 
393  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
395  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
396 
407  bool
408  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
409 
425  bool
426  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
427 
433  ome::compat::weak_ptr<ome::xml::model::Pixels>
434  getPixels ();
435 
441  const ome::compat::weak_ptr<ome::xml::model::Pixels>
442  getPixels () const;
443 
449  void
450  setPixels (ome::compat::weak_ptr<ome::xml::model::Pixels>& pixels_BackReference);
451 
452 
455  asXMLElement (common::xml::dom::Document& document) const;
456 
457 
458  protected:
459  // Documented in base class.
462  common::xml::dom::Element& element) const;
463 
464  public:
465  // Documented in superclass.
466  const std::string&
467  getXMLNamespace() const;
468  };
469 
470  }
471  }
472 }
473 
474 #endif // OME_XML_MODEL_PLANE_H
475 
476 /*
477  * Local Variables:
478  * mode:C++
479  * End:
480  */
ome::compat::shared_ptr< double > positionY
PositionY property.
Definition: Plane.h:90
void setPixels(ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set the Pixels property.
Definition: Plane.cpp:582
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< double > getPositionZ()
Get the PositionZ property.
Definition: Plane.cpp:361
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:520
ome::compat::shared_ptr< std::string > hashSHA1
HashSHA1 property.
Definition: Plane.h:100
ome::compat::shared_ptr< double > getPositionY()
Get the PositionY property.
Definition: Plane.cpp:403
ome::compat::shared_ptr< double > positionX
PositionX property.
Definition: Plane.h:88
ome::compat::shared_ptr< double > getDeltaT()
Get the DeltaT property.
Definition: Plane.cpp:424
void setDeltaT(ome::compat::shared_ptr< double > &deltaT)
Set the DeltaT property.
Definition: Plane.cpp:438
ome::compat::shared_ptr< double > getExposureTime()
Get the ExposureTime property.
Definition: Plane.cpp:340
ome::compat::shared_ptr< double > exposureTime
ExposureTime property.
Definition: Plane.h:84
DOM Document wrapper.
Definition: Document.h:80
ome::compat::shared_ptr< double > deltaT
DeltaT property.
Definition: Plane.h:92
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Plane.cpp:514
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:309
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
virtual ~Plane()
Destructor.
Definition: Plane.cpp:167
void setPositionX(ome::compat::shared_ptr< double > &positionX)
Set the PositionX property.
Definition: Plane.cpp:396
Plane()
Default constructor.
Definition: Plane.cpp:128
ome::compat::shared_ptr< double > positionZ
PositionZ property.
Definition: Plane.h:86
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:197
void setTheT(const ome::xml::model::primitives::NonNegativeInteger &theT)
Set the TheT property.
Definition: Plane.cpp:480
void setTheZ(const ome::xml::model::primitives::NonNegativeInteger &theZ)
Set the TheZ property.
Definition: Plane.cpp:466
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
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:596
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
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:589
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Plane.cpp:737
void setPositionY(ome::compat::shared_ptr< double > &positionY)
Set the PositionY property.
Definition: Plane.cpp:417
ome::compat::shared_ptr< std::string > getHashSHA1()
Get the HashSHA1 property.
Definition: Plane.cpp:487
const ome::xml::model::primitives::NonNegativeInteger & getTheT() const
Get the TheT property.
Definition: Plane.cpp:473
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:508
const ome::xml::model::primitives::NonNegativeInteger & getTheC() const
Get the TheC property.
Definition: Plane.cpp:445
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Plane.cpp:188
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: Plane.h:102
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Plane.cpp:536
const std::string & elementName() const
Get the element name of this model object.
Definition: Plane.cpp:181
ome::compat::shared_ptr< double > getPositionX()
Get the PositionX property.
Definition: Plane.cpp:382
const ome::xml::model::primitives::NonNegativeInteger & getTheZ() const
Get the TheZ property.
Definition: Plane.cpp:459
ome::xml::model::primitives::NonNegativeInteger theC
TheC property.
Definition: Plane.h:94
ome::compat::weak_ptr< ome::xml::model::Pixels > pixels
Pixels_BackReference back reference.
Definition: Plane.h:104
ome::xml::model::primitives::NonNegativeInteger theT
TheT property.
Definition: Plane.h:98
Plane model object.
Definition: Plane.h:80
ome::compat::weak_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Plane.cpp:568
void setPositionZ(ome::compat::shared_ptr< double > &positionZ)
Set the PositionZ property.
Definition: Plane.cpp:375
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:526
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:172
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Plane.cpp:550
void setHashSHA1(ome::compat::shared_ptr< std::string > &hashSHA1)
Set the HashSHA1 property.
Definition: Plane.cpp:501
ome::xml::model::primitives::NonNegativeInteger theZ
TheZ property.
Definition: Plane.h:96
void setExposureTime(ome::compat::shared_ptr< double > &exposureTime)
Set the ExposureTime property.
Definition: Plane.cpp:354
Boost.Log compatibility.
void setTheC(const ome::xml::model::primitives::NonNegativeInteger &theC)
Set the TheC property.
Definition: Plane.cpp:452
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
Xerces-C modern C++ wrapper.
Definition: Base.h:53