ome-xml 5.2.3

Well.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_WELL_H
47 #define OME_XML_MODEL_WELL_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/Plate.h>
65 #include <ome/xml/model/Reagent.h>
66 #include <ome/xml/model/detail/OMEModelObject.h>
67 #include <ome/xml/model/primitives/Color.h>
68 #include <ome/xml/model/primitives/NonNegativeInteger.h>
69
70 namespace ome
71 {
72 namespace xml
73 {
74 namespace model
75 {
76
77 // Forward declarations.
78 class Annotation;
79 class OMEModel;
80 class WellSample;
81
85 class Well : public detail::OMEModelObject
86 {
87 private:
88 class Impl;
90 ome::compat::shared_ptr<Impl> impl;
91
92 public:
94 Well();
95
101 Well (const Well& copy);
102
104 virtual
105 ~Well ();
106
121 static ome::compat::shared_ptr< Well>
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 Well&
136 operator= (const Well&);
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 // -- Well 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 ome::compat::shared_ptr<std::string>
160 getExternalIdentifier ();
161
167 const ome::compat::shared_ptr<std::string>
168 getExternalIdentifier () const;
169
175 void
176 setExternalIdentifier (ome::compat::shared_ptr<std::string>& externalIdentifier);
177
183 const ome::xml::model::primitives::NonNegativeInteger&
184 getColumn () const;
185
191 void
192 setColumn (const ome::xml::model::primitives::NonNegativeInteger& column);
193
199 ome::compat::shared_ptr<std::string>
200 getExternalDescription ();
201
207 const ome::compat::shared_ptr<std::string>
208 getExternalDescription () const;
209
215 void
216 setExternalDescription (ome::compat::shared_ptr<std::string>& externalDescription);
217
223 ome::compat::shared_ptr<ome::xml::model::primitives::Color>
224 getColor ();
225
231 const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
232 getColor () const;
233
239 void
240 setColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& color);
241
247 ome::compat::shared_ptr<std::string>
248 getType ();
249
255 const ome::compat::shared_ptr<std::string>
256 getType () const;
257
263 void
264 setType (ome::compat::shared_ptr<std::string>& type);
265
271 const std::string&
272 getID () const;
273
279 void
280 setID (const std::string& id);
281
287 const ome::xml::model::primitives::NonNegativeInteger&
288 getRow () const;
289
295 void
296 setRow (const ome::xml::model::primitives::NonNegativeInteger& row);
297
303 std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type
304 sizeOfWellSampleList () const;
305
312 std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >&
313 getWellSampleList ();
314
321 const std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >&
322 getWellSampleList () const;
323
331 ome::compat::shared_ptr<ome::xml::model::WellSample>&
332 getWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index);
333
341 const ome::compat::shared_ptr<ome::xml::model::WellSample>&
342 getWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index) const;
343
351 void
352 setWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index,
353 ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
354
363 void
364 addWellSample (ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
365
375 void
376 removeWellSample (ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
377
384 ome::compat::weak_ptr<ome::xml::model::Reagent>
385 getLinkedReagent ();
386
393 const ome::compat::weak_ptr<ome::xml::model::Reagent>
394 getLinkedReagent () const;
395
401 void
402 linkReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
403
413 void
414 unlinkReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
415
421 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
422 sizeOfLinkedAnnotationList () const;
423
429 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
430 getLinkedAnnotationList () const;
431
439 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
440 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
441
452 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
453 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
454 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
455
466 bool
467 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
468
484 bool
485 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
486
492 ome::compat::weak_ptr<ome::xml::model::Plate>
493 getPlate ();
494
500 const ome::compat::weak_ptr<ome::xml::model::Plate>
501 getPlate () const;
502
508 void
509 setPlate (ome::compat::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
510
512 virtual common::xml::dom::Element
513 asXMLElement (common::xml::dom::Document& document) const;
514
515
516 protected:
517 // Documented in base class.
518 virtual common::xml::dom::Element
519 asXMLElementInternal (common::xml::dom::Document& document,
520 common::xml::dom::Element& element) const;
521
522 public:
523 // Documented in superclass.
524 const std::string&
525 getXMLNamespace() const;
526 };
527
528 }
529 }
530 }
531
532 #endif // OME_XML_MODEL_WELL_H
533
534 /*
535 * Local Variables:
536 * mode:C++
537 * End:
538 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Well::getID
const std::string & getID() const
Get the ID property.
Definition: Well.cpp:491
ome::xml::model::Well::sizeOfWellSampleList
std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > >::size_type sizeOfWellSampleList() const
Get size of linked WellSample list.
Definition: Well.cpp:519
ome::xml::model::Well::setExternalDescription
void setExternalDescription(ome::compat::shared_ptr< std::string > &externalDescription)
Set the ExternalDescription property.
Definition: Well.cpp:442
ome::xml::model::Well::getWellSampleList
std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > > & getWellSampleList()
Get the WellSample list.
Definition: Well.cpp:525
ome::xml::model::Well::getExternalIdentifier
ome::compat::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Well.cpp:393
ome::xml::model::Well::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: Well.cpp:624
ome::xml::model::Well::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Well.cpp:686
ome::xml::model::Well::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Well.cpp:606
ome::xml::model::Well::getLinkedReagent
ome::compat::weak_ptr< ome::xml::model::Reagent > getLinkedReagent()
Get linked Reagent.
Definition: Well.cpp:577
ome::xml::model::Well::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: Well.cpp:618
ome::common::xml::dom::Document
ome::xml::model::Well::getWellSample
ome::compat::shared_ptr< ome::xml::model::WellSample > & getWellSample(std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > >::size_type index)
Get WellSample.
Definition: Well.cpp:537
ome::xml::model::Well::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Well.cpp:218
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Well::getColor
ome::compat::shared_ptr< ome::xml::model::primitives::Color > getColor()
Get the Color property.
Definition: Well.cpp:449
ome::xml::model::Well::setRow
void setRow(const ome::xml::model::primitives::NonNegativeInteger &row)
Set the Row property.
Definition: Well.cpp:512
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::Well::setWellSample
void setWellSample(std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > >::size_type index, ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Set WellSample.
Definition: Well.cpp:549
ome::xml::model::Well
Well model object.
Definition: Well.h:85
ome::xml::model::Well::create
static ome::compat::shared_ptr< Well > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Well model object from DOM element.
Definition: Well.cpp:209
ome::xml::model::Well::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Well.cpp:839
ome::xml::model::Well::~Well
virtual ~Well()
Destructor.
Definition: Well.cpp:204
ome::xml::model::Well::setType
void setType(ome::compat::shared_ptr< std::string > &type)
Set the Type property.
Definition: Well.cpp:484
ome::xml::model::Well::getColumn
const ome::xml::model::primitives::NonNegativeInteger & getColumn() const
Get the Column property.
Definition: Well.cpp:414
ome::xml::model::Well::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: Well.cpp:351
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::Well::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Well.h:88
ome::xml::model::Well::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Well.cpp:634
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Well::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Well.cpp:648
ome::xml::model::Well::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Well.cpp:225
ome::xml::model::Well::addWellSample
void addWellSample(ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Add WellSample.
Definition: Well.cpp:558
ome::xml::model::Well::setID
void setID(const std::string &id)
Set the ID property.
Definition: Well.cpp:498
ome::xml::model::Well::setExternalIdentifier
void setExternalIdentifier(ome::compat::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Well.cpp:407
ome::xml::model::Well::getExternalDescription
ome::compat::shared_ptr< std::string > getExternalDescription()
Get the ExternalDescription property.
Definition: Well.cpp:428
ome::xml::model::Well::unlinkReagent
void unlinkReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Unlink Reagent.
Definition: Well.cpp:596
ome::xml::model::Well::setColumn
void setColumn(const ome::xml::model::primitives::NonNegativeInteger &column)
Set the Column property.
Definition: Well.cpp:421
ome::xml::model::Well::getPlate
ome::compat::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: Well.cpp:666
ome::xml::model::Well::removeWellSample
void removeWellSample(ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Remove WellSample.
Definition: Well.cpp:566
ome::xml::model::Well::linkReagent
void linkReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Link Reagent.
Definition: Well.cpp:590
ome::xml::model::Well::Impl
Private implementation details of Well model object.
Definition: Well.cpp:80
ome::xml::model::Well::operator=
Well & operator=(const Well &)
Assignment operator (deleted).
ome::xml::model::Well::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Well.cpp:612
ome::xml::model::Well::getType
ome::compat::shared_ptr< std::string > getType()
Get the Type property.
Definition: Well.cpp:470
log.h
ome::xml::model::Well::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: Well.cpp:693
ome::xml::model::Well::setColor
void setColor(ome::compat::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Well.cpp:463
ome::xml::model::Well::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: Well.cpp:233
ome::xml::model::Well::Well
Well()
Default constructor.
Definition: Well.cpp:189
ome::xml::model::Well::getRow
const ome::xml::model::primitives::NonNegativeInteger & getRow() const
Get the Row property.
Definition: Well.cpp:505
ome::xml::model::Well::setPlate
void setPlate(ome::compat::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: Well.cpp:680
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119