ome-xml 5.2.0

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

- File List

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/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
83 class WellSample : public detail::OMEModelObject
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 WellSample();
93
99 WellSample (const WellSample& copy);
100
102 virtual
103 ~WellSample ();
104
119 static ome::compat::shared_ptr< WellSample>
120 create(const common::xml::dom::Element& element,
121 ome::xml::model::OMEModel& model);
122
123 // Documented in superclass.
124 const std::string&
125 elementName() const;
126
127 // Documented in superclass.
128 bool
129 validElementName(const std::string& name) const;
130
131
132 // -- OMEModelObject API methods --
133
135 virtual void
136 update(const common::xml::dom::Element& element,
137 ome::xml::model::OMEModel& model);
138
139 public:
140 // -- WellSample API methods --
141
143 bool
144 link (ome::compat::shared_ptr<Reference>& reference,
145 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
146
152 const ome::xml::model::primitives::NonNegativeInteger&
153 getIndex () const;
154
160 void
161 setIndex (const ome::xml::model::primitives::NonNegativeInteger& index);
162
168 ome::compat::shared_ptr<double>
169 getPositionX ();
170
176 const ome::compat::shared_ptr<double>
177 getPositionX () const;
178
184 void
185 setPositionX (ome::compat::shared_ptr<double>& positionX);
186
192 ome::compat::shared_ptr<double>
193 getPositionY ();
194
200 const ome::compat::shared_ptr<double>
201 getPositionY () const;
202
208 void
209 setPositionY (ome::compat::shared_ptr<double>& positionY);
210
216 const std::string&
217 getID () const;
218
224 void
225 setID (const std::string& id);
226
232 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
233 getTimepoint ();
234
240 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
241 getTimepoint () const;
242
248 void
249 setTimepoint (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& timepoint);
250
257 ome::compat::weak_ptr<ome::xml::model::Image>
258 getLinkedImage ();
259
266 const ome::compat::weak_ptr<ome::xml::model::Image>
267 getLinkedImage () const;
268
274 void
275 linkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
276
286 void
287 unlinkImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
288
294 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
295 sizeOfLinkedAnnotationList () const;
296
302 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
303 getLinkedAnnotationList () const;
304
312 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
313 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
314
325 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
326 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
327 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
328
339 bool
340 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
341
357 bool
358 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
359
365 OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type
366 sizeOfLinkedPlateAcquisitionList () const;
367
373 OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type
374 getLinkedPlateAcquisitionList () const;
375
383 const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
384 getLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type index) const;
385
396 const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
397 setLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, ome::compat::weak_ptr>::type::size_type index,
398 const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
399
410 bool
411 linkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
412
428 bool
429 unlinkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
430
436 ome::compat::weak_ptr<ome::xml::model::Well>
437 getWell ();
438
444 const ome::compat::weak_ptr<ome::xml::model::Well>
445 getWell () const;
446
452 void
453 setWell (ome::compat::weak_ptr<ome::xml::model::Well>& well_BackReference);
454
455
457 virtual common::xml::dom::Element
458 asXMLElement (common::xml::dom::Document& document) const;
459
460
461 protected:
462 // Documented in base class.
463 virtual common::xml::dom::Element
464 asXMLElementInternal (common::xml::dom::Document& document,
465 common::xml::dom::Element& element) const;
466
467 public:
468 // Documented in superclass.
469 const std::string&
470 getXMLNamespace() const;
471 };
472
473 }
474 }
475 }
476
477 #endif // OME_XML_MODEL_WELLSAMPLE_H
478
479 /*
480 * Local Variables:
481 * mode:C++
482 * End:
483 */
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:357
ome::xml::model::WellSample::linkPlateAcquisition
bool linkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: WellSample.cpp:558
ome::xml::model::WellSample::setID
void setID(const std::string &id)
Set the ID property.
Definition: WellSample.cpp:413
ome::xml::model::WellSample::getWell
ome::compat::weak_ptr< ome::xml::model::Well > getWell()
Get the Well property.
Definition: WellSample.cpp:588
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:609
ome::xml::model::WellSample::setPositionY
void setPositionY(ome::compat::shared_ptr< double > &positionY)
Set the PositionY property.
Definition: WellSample.cpp:399
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:221
ome::xml::model::WellSample::getLinkedImage
ome::compat::weak_ptr< ome::xml::model::Image > getLinkedImage()
Get linked Image.
Definition: WellSample.cpp:441
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:548
ome::xml::model::WellSample::setPositionX
void setPositionX(ome::compat::shared_ptr< double > &positionX)
Set the PositionX property.
Definition: WellSample.cpp:378
ome::xml::model::WellSample::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: WellSample.cpp:476
ome::xml::model::WellSample::Impl
Private implementation details of WellSample model object.
Definition: WellSample.cpp:76
ome::xml::model::WellSample::getPositionY
ome::compat::shared_ptr< double > getPositionY()
Get the PositionY property.
Definition: WellSample.cpp:385
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:542
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::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:191
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:212
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:196
ome::xml::model::WellSample::setWell
void setWell(ome::compat::weak_ptr< ome::xml::model::Well > &well_BackReference)
Set the Well property.
Definition: WellSample.cpp:602
ome::xml::model::WellSample::unlinkImage
void unlinkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: WellSample.cpp:460
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::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:530
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:571
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:616
ome::xml::model::WellSample
WellSample model object.
Definition: WellSample.h:83
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:536
ome::xml::model::WellSample::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: WellSample.cpp:482
ome::xml::model::WellSample::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: WellSample.cpp:498
ome::xml::model::WellSample::linkImage
void linkImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: WellSample.cpp:454
ome::xml::model::WellSample::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: WellSample.h:86
ome::xml::model::WellSample::setTimepoint
void setTimepoint(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &timepoint)
Set the Timepoint property.
Definition: WellSample.cpp:434
ome::xml::model::WellSample::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: WellSample.cpp:727
ome::xml::model::WellSample::WellSample
WellSample()
Default constructor.
Definition: WellSample.cpp:172
ome::xml::model::WellSample::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: WellSample.cpp:512
ome::xml::model::WellSample::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: WellSample.cpp:205
ome::xml::model::WellSample::getIndex
const ome::xml::model::primitives::NonNegativeInteger & getIndex() const
Get the Index property.
Definition: WellSample.cpp:350
log.h
ome::xml::model::WellSample::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: WellSample.cpp:488
ome::xml::model::WellSample::sizeOfLinkedAnnotationList
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:470
ome::xml::model::WellSample::getTimepoint
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getTimepoint()
Get the Timepoint property.
Definition: WellSample.cpp:420
ome::xml::model::WellSample::getPositionX
ome::compat::shared_ptr< double > getPositionX()
Get the PositionX property.
Definition: WellSample.cpp:364
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:308
ome::xml::model::WellSample::getID
const std::string & getID() const
Get the ID property.
Definition: WellSample.cpp:406
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119