ome-xml 5.2.3

WellSample.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_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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Image.h>
65 #include <ome/xml/model/Well.h>
66 #include <ome/xml/model/detail/OMEModelObject.h>
67 #include <ome/xml/model/enums/UnitsLength.h>
68 #include <ome/xml/model/primitives/NonNegativeInteger.h>
69 #include <ome/xml/model/primitives/Timestamp.h>
70
71 namespace ome
72 {
73 namespace xml
74 {
75 namespace model
76 {
77
78 // Forward declarations.
79 class OMEModel;
80 class PlateAcquisition;
81
85 class WellSample : public detail::OMEModelObject
86 {
87 private:
88 class Impl;
90 ome::compat::shared_ptr<Impl> impl;
91
92 public:
94 WellSample();
95
101 WellSample (const WellSample& copy);
102
104 virtual
105 ~WellSample ();
106
121 static ome::compat::shared_ptr< WellSample>
122 create(const common::xml::dom::Element& element,
123 ome::xml::model::OMEModel& model);
124
125 // Documented in superclass.
126 const std::string&
127 elementName() const;
128
129 // Documented in superclass.
130 bool
131 validElementName(const std::string& name) const;
132
133 private:
135 WellSample&
136 operator= (const WellSample&);
137
138 public:
139 // -- OMEModelObject API methods --
140
142 virtual void
143 update(const common::xml::dom::Element& element,
144 ome::xml::model::OMEModel& model);
145
146 public:
147 // -- WellSample API methods --
148
150 bool
151 link (ome::compat::shared_ptr<Reference>& reference,
152 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
153
159 const ome::xml::model::primitives::NonNegativeInteger&
160 getIndex () const;
161
167 void
168 setIndex (const ome::xml::model::primitives::NonNegativeInteger& index);
169
175 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
176 getPositionX ();
177
183 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
184 getPositionX () const;
185
191 void
192 setPositionX (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >& positionX);
193
199 ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
200 getPositionY ();
201
207 const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >&
208 getPositionY () const;
209
215 void
216 setPositionY (const ome::compat::shared_ptr<ome::xml::model::primitives::Quantity<ome::xml::model::enums::UnitsLength > >& positionY);
217
223 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
224 getTimepoint ();
225
231 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
232 getTimepoint () const;
233
239 void
240 setTimepoint (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& timepoint);
241
247 const std::string&
248 getID () const;
249
255 void
256 setID (const std::string& id);
257
264 ome::compat::weak_ptr<ome::xml::model::Image>
265 getLinkedImage ();
266
273 const ome::compat::weak_ptr<ome::xml::model::Image>
274 getLinkedImage () const;
275
281 void
282 linkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
283
293 void
294 unlinkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
295
301 OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type
302 sizeOfLinkedPlateAcquisitionList () const;
303
309 OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type
310 getLinkedPlateAcquisitionList () const;
311
319 const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
320 getLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type index) const;
321
332 const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
333 setLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type index,
334 const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
335
346 bool
347 linkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
348
364 bool
365 unlinkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
366
372 ome::compat::weak_ptr<ome::xml::model::Well>
373 getWell ();
374
380 const ome::compat::weak_ptr<ome::xml::model::Well>
381 getWell () const;
382
388 void
389 setWell (ome::compat::weak_ptr<ome::xml::model::Well>& well_BackReference);
390
392 virtual common::xml::dom::Element
393 asXMLElement (common::xml::dom::Document& document) const;
394
395
396 protected:
397 // Documented in base class.
398 virtual common::xml::dom::Element
399 asXMLElementInternal (common::xml::dom::Document& document,
400 common::xml::dom::Element& element) const;
401
402 public:
403 // Documented in superclass.
404 const std::string&
405 getXMLNamespace() const;
406 };
407
408 }
409 }
410 }
411
412 #endif // OME_XML_MODEL_WELLSAMPLE_H
413
414 /*
415 * Local Variables:
416 * mode:C++
417 * End:
418 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::WellSample::setIndex
void setIndex(const ome::xml::model::primitives::NonNegativeInteger &index)
Set the Index property.
Definition: WellSample.cpp:328
ome::xml::model::WellSample::linkPlateAcquisition
bool linkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: WellSample.cpp:469
ome::xml::model::WellSample::setID
void setID(const std::string &id)
Set the ID property.
Definition: WellSample.cpp:405
ome::xml::model::WellSample::getWell
ome::compat::weak_ptr< ome::xml::model::Well > getWell()
Get the Well property.
Definition: WellSample.cpp:499
ome::xml::model::WellSample::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: WellSample.cpp:207
ome::xml::model::WellSample::getLinkedImage
ome::compat::weak_ptr< ome::xml::model::Image > getLinkedImage()
Get linked Image.
Definition: WellSample.cpp:412
ome::xml::model::WellSample::setLinkedPlateAcquisition
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:459
ome::xml::model::WellSample::getIndex
const ome::xml::model::primitives::NonNegativeInteger & getIndex() const
Get the Index property.
Definition: WellSample.cpp:321
ome::xml::model::WellSample::setPositionX
void setPositionX(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionX)
Set the PositionX property.
Definition: WellSample.cpp:349
ome::xml::model::WellSample::operator=
WellSample & operator=(const WellSample &)
Assignment operator (deleted).
ome::xml::model::WellSample::getID
const std::string & getID() const
Get the ID property.
Definition: WellSample.cpp:398
ome::xml::model::WellSample::Impl
Private implementation details of WellSample model object.
Definition: WellSample.cpp:75
ome::xml::model::WellSample::sizeOfLinkedPlateAcquisitionList
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:441
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::WellSample::asXMLElement
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:519
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::WellSample::~WellSample
virtual ~WellSample()
Destructor.
Definition: WellSample.cpp:178
ome::xml::model::WellSample::getPositionY
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionY()
Get the PositionY property.
Definition: WellSample.cpp:356
ome::xml::model::WellSample::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: WellSample.cpp:199
ome::xml::model::WellSample::create
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:183
ome::xml::model::WellSample::setWell
void setWell(ome::compat::weak_ptr< ome::xml::model::Well > &well_BackReference)
Set the Well property.
Definition: WellSample.cpp:513
ome::xml::model::WellSample::unlinkImage
void unlinkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: WellSample.cpp:431
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::WellSample::getPositionX
ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > & getPositionX()
Get the PositionX property.
Definition: WellSample.cpp:335
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::WellSample::unlinkPlateAcquisition
bool unlinkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: WellSample.cpp:482
ome::xml::model::WellSample::getLinkedPlateAcquisitionList
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type getLinkedPlateAcquisitionList() const
Get the linked PlateAcquisition list.
Definition: WellSample.cpp:447
ome::xml::model::WellSample
WellSample model object.
Definition: WellSample.h:85
ome::xml::model::WellSample::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: WellSample.cpp:615
ome::xml::model::WellSample::setPositionY
void setPositionY(const ome::compat::shared_ptr< ome::xml::model::primitives::Quantity< ome::xml::model::enums::UnitsLength > > &positionY)
Set the PositionY property.
Definition: WellSample.cpp:370
ome::xml::model::WellSample::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: WellSample.cpp:192
ome::xml::model::WellSample::getLinkedPlateAcquisition
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:453
ome::xml::model::WellSample::linkImage
void linkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: WellSample.cpp:425
ome::xml::model::WellSample::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: WellSample.h:88
ome::xml::model::WellSample::setTimepoint
void setTimepoint(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &timepoint)
Set the Timepoint property.
Definition: WellSample.cpp:391
ome::xml::model::primitives::Quantity
A quantity of a defined unit.
Definition: Quantity.h:57
ome::xml::model::WellSample::WellSample
WellSample()
Default constructor.
Definition: WellSample.cpp:163
ome::xml::model::WellSample::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: WellSample.cpp:526
log.h
ome::xml::model::WellSample::getTimepoint
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getTimepoint()
Get the Timepoint property.
Definition: WellSample.cpp:377
ome::xml::model::WellSample::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: WellSample.cpp:295
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119