bioformats  5.1.2
WellSample.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_WELLSAMPLE_H
47 #define OME_XML_MODEL_WELLSAMPLE_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/Image.h>
63 #include <ome/xml/model/Well.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/primitives/NonNegativeInteger.h>
66 #include <ome/xml/model/primitives/Timestamp.h>
67 
68 namespace ome
69 {
70  namespace xml
71  {
72  namespace model
73  {
74 
75  // Forward declarations.
76  class Annotation;
77  class OMEModel;
78  class PlateAcquisition;
79 
84  {
85  private:
89  ome::compat::shared_ptr<double> positionX;
91  ome::compat::shared_ptr<double> positionY;
93  std::string id;
95  ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp> timepoint;
97  ome::compat::weak_ptr<ome::xml::model::Image> image;
103  ome::compat::weak_ptr<ome::xml::model::Well> well;
104 
105  public:
107  WellSample ();
108 
114  WellSample (const WellSample& copy);
115 
117  virtual
118  ~WellSample ();
119 
120 
121 
136  static ome::compat::shared_ptr< WellSample>
137  create(const common::xml::dom::Element& element,
139 
140  // Documented in superclass.
141  const std::string&
142  elementName() const;
143 
144  // Documented in superclass.
145  bool
146  validElementName(const std::string& name) const;
147 
148 
149  // -- OMEModelObject API methods --
150 
152  virtual void
153  update(const common::xml::dom::Element& element,
155 
156  public:
157  // -- WellSample API methods --
158 
160  bool
161  link (ome::compat::shared_ptr<Reference>& reference,
162  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
163 
170  getIndex () const;
171 
177  void
179 
185  ome::compat::shared_ptr<double>
186  getPositionX ();
187 
193  const ome::compat::shared_ptr<double>
194  getPositionX () const;
195 
201  void
202  setPositionX (ome::compat::shared_ptr<double>& positionX);
203 
209  ome::compat::shared_ptr<double>
210  getPositionY ();
211 
217  const ome::compat::shared_ptr<double>
218  getPositionY () const;
219 
225  void
226  setPositionY (ome::compat::shared_ptr<double>& positionY);
227 
233  const std::string&
234  getID () const;
235 
241  void
242  setID (const std::string& id);
243 
249  ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
250  getTimepoint ();
251 
257  const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
258  getTimepoint () const;
259 
265  void
266  setTimepoint (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& timepoint);
267 
274  ome::compat::weak_ptr<ome::xml::model::Image>
275  getLinkedImage ();
276 
283  const ome::compat::weak_ptr<ome::xml::model::Image>
284  getLinkedImage () const;
285 
291  void
292  linkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
293 
303  void
304  unlinkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
305 
313 
320  getLinkedAnnotationList () const;
321 
329  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
331 
342  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
344  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
345 
356  bool
357  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
358 
374  bool
375  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
376 
384 
392 
400  const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
402 
413  const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
415  const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
416 
427  bool
428  linkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
429 
445  bool
446  unlinkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
447 
453  ome::compat::weak_ptr<ome::xml::model::Well>
454  getWell ();
455 
461  const ome::compat::weak_ptr<ome::xml::model::Well>
462  getWell () const;
463 
469  void
470  setWell (ome::compat::weak_ptr<ome::xml::model::Well>& well_BackReference);
471 
472 
475  asXMLElement (common::xml::dom::Document& document) const;
476 
477 
478  protected:
479  // Documented in base class.
482  common::xml::dom::Element& element) const;
483 
484  public:
485  // Documented in superclass.
486  const std::string&
487  getXMLNamespace() const;
488  };
489 
490  }
491  }
492 }
493 
494 #endif // OME_XML_MODEL_WELLSAMPLE_H
495 
496 /*
497  * Local Variables:
498  * mode:C++
499  * End:
500  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void setIndex(const ome::xml::model::primitives::NonNegativeInteger &index)
Set the Index property.
Definition: WellSample.cpp:326
bool linkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: WellSample.cpp:527
void setID(const std::string &id)
Set the ID property.
Definition: WellSample.cpp:382
ome::compat::weak_ptr< ome::xml::model::Well > getWell()
Get the Well property.
Definition: WellSample.cpp:557
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: WellSample.cpp:578
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > timepoint
Timepoint property.
Definition: WellSample.h:95
void setPositionY(ome::compat::shared_ptr< double > &positionY)
Set the PositionY property.
Definition: WellSample.cpp:368
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type plateAcquisitions
PlateAcquisition_BackReference back reference (occurs more than once)
Definition: WellSample.h:101
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: WellSample.cpp:190
ome::compat::weak_ptr< ome::xml::model::Image > getLinkedImage()
Get linked Image.
Definition: WellSample.cpp:410
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & setLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Set linked PlateAcquisition.
Definition: WellSample.cpp:517
ome::compat::shared_ptr< double > positionX
PositionX property.
Definition: WellSample.h:89
void setPositionX(ome::compat::shared_ptr< double > &positionX)
Set the PositionX property.
Definition: WellSample.cpp:347
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: WellSample.cpp:445
ome::xml::model::primitives::NonNegativeInteger index
Index property.
Definition: WellSample.h:87
ome::compat::shared_ptr< double > getPositionY()
Get the PositionY property.
Definition: WellSample.cpp:354
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & getLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index) const
Get linked PlateAcquisition.
Definition: WellSample.cpp:511
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: WellSample.h:99
virtual ~WellSample()
Destructor.
Definition: WellSample.cpp:160
std::string id
ID property.
Definition: WellSample.h:93
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: WellSample.cpp:181
static ome::compat::shared_ptr< WellSample > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a WellSample model object from DOM element.
Definition: WellSample.cpp:165
void setWell(ome::compat::weak_ptr< ome::xml::model::Well > &well_BackReference)
Set the Well property.
Definition: WellSample.cpp:571
void unlinkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: WellSample.cpp:429
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: WellSample.cpp:499
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
bool unlinkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: WellSample.cpp:540
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: WellSample.cpp:585
WellSample model object.
Definition: WellSample.h:83
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type getLinkedPlateAcquisitionList() const
Get the linked PlateAcquisition list.
Definition: WellSample.cpp:505
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: WellSample.cpp:451
ome::compat::shared_ptr< double > positionY
PositionY property.
Definition: WellSample.h:91
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: WellSample.cpp:467
void linkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: WellSample.cpp:423
void setTimepoint(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &timepoint)
Set the Timepoint property.
Definition: WellSample.cpp:403
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: WellSample.cpp:696
WellSample()
Default constructor.
Definition: WellSample.cpp:125
ome::compat::weak_ptr< ome::xml::model::Image > image
ImageRef reference.
Definition: WellSample.h:97
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: WellSample.cpp:481
ome::compat::weak_ptr< ome::xml::model::Well > well
Well_BackReference back reference.
Definition: WellSample.h:103
const std::string & elementName() const
Get the element name of this model object.
Definition: WellSample.cpp:174
const ome::xml::model::primitives::NonNegativeInteger & getIndex() const
Get the Index property.
Definition: WellSample.cpp:319
Boost.Log compatibility.
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: WellSample.cpp:457
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: WellSample.cpp:439
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getTimepoint()
Get the Timepoint property.
Definition: WellSample.cpp:389
ome::compat::shared_ptr< double > getPositionX()
Get the PositionX property.
Definition: WellSample.cpp:333
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: WellSample.cpp:277
const std::string & getID() const
Get the ID property.
Definition: WellSample.cpp:375
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