ome-xml 5.2.0

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

- File List

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/Plate.h>
63 #include <ome/xml/model/Reagent.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/primitives/Color.h>
66 #include <ome/xml/model/primitives/NonNegativeInteger.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 WellSample;
79
83 class Well : public detail::OMEModelObject
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 Well();
93
99 Well (const Well& copy);
100
102 virtual
103 ~Well ();
104
119 static ome::compat::shared_ptr< Well>
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 // -- Well 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 ome::compat::shared_ptr<std::string>
153 getExternalIdentifier ();
154
160 const ome::compat::shared_ptr<std::string>
161 getExternalIdentifier () const;
162
168 void
169 setExternalIdentifier (ome::compat::shared_ptr<std::string>& externalIdentifier);
170
176 const ome::xml::model::primitives::NonNegativeInteger&
177 getColumn () const;
178
184 void
185 setColumn (const ome::xml::model::primitives::NonNegativeInteger& column);
186
192 ome::compat::shared_ptr<std::string>
193 getExternalDescription ();
194
200 const ome::compat::shared_ptr<std::string>
201 getExternalDescription () const;
202
208 void
209 setExternalDescription (ome::compat::shared_ptr<std::string>& externalDescription);
210
216 ome::compat::shared_ptr<ome::xml::model::primitives::Color>
217 getColor ();
218
224 const ome::compat::shared_ptr<ome::xml::model::primitives::Color>
225 getColor () const;
226
232 void
233 setColor (ome::compat::shared_ptr<ome::xml::model::primitives::Color>& color);
234
240 ome::compat::shared_ptr<std::string>
241 getType ();
242
248 const ome::compat::shared_ptr<std::string>
249 getType () const;
250
256 void
257 setType (ome::compat::shared_ptr<std::string>& type);
258
264 const std::string&
265 getID () const;
266
272 void
273 setID (const std::string& id);
274
280 const ome::xml::model::primitives::NonNegativeInteger&
281 getRow () const;
282
288 void
289 setRow (const ome::xml::model::primitives::NonNegativeInteger& row);
290
296 std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type
297 sizeOfWellSampleList () const;
298
305 std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >&
306 getWellSampleList ();
307
314 const std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >&
315 getWellSampleList () const;
316
324 ome::compat::shared_ptr<ome::xml::model::WellSample>&
325 getWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index);
326
334 const ome::compat::shared_ptr<ome::xml::model::WellSample>&
335 getWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index) const;
336
344 void
345 setWellSample (std::vector<ome::compat::shared_ptr<ome::xml::model::WellSample> >::size_type index,
346 ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
347
356 void
357 addWellSample (ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
358
368 void
369 removeWellSample (ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
370
377 ome::compat::weak_ptr<ome::xml::model::Reagent>
378 getLinkedReagent ();
379
386 const ome::compat::weak_ptr<ome::xml::model::Reagent>
387 getLinkedReagent () const;
388
394 void
395 linkReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
396
406 void
407 unlinkReagent (ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent);
408
414 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
415 sizeOfLinkedAnnotationList () const;
416
422 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
423 getLinkedAnnotationList () const;
424
432 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
433 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
434
445 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
446 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
447 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
448
459 bool
460 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
461
477 bool
478 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
479
485 ome::compat::weak_ptr<ome::xml::model::Plate>
486 getPlate ();
487
493 const ome::compat::weak_ptr<ome::xml::model::Plate>
494 getPlate () const;
495
501 void
502 setPlate (ome::compat::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
503
504
506 virtual common::xml::dom::Element
507 asXMLElement (common::xml::dom::Document& document) const;
508
509
510 protected:
511 // Documented in base class.
512 virtual common::xml::dom::Element
513 asXMLElementInternal (common::xml::dom::Document& document,
514 common::xml::dom::Element& element) const;
515
516 public:
517 // Documented in superclass.
518 const std::string&
519 getXMLNamespace() const;
520 };
521
522 }
523 }
524 }
525
526 #endif // OME_XML_MODEL_WELL_H
527
528 /*
529 * Local Variables:
530 * mode:C++
531 * End:
532 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Well::setExternalDescription
void setExternalDescription(ome::compat::shared_ptr< std::string > &externalDescription)
Set the ExternalDescription property.
Definition: Well.cpp:446
ome::xml::model::Well::getWellSampleList
std::vector< ome::compat::shared_ptr< ome::xml::model::WellSample > > & getWellSampleList()
Get the WellSample list.
Definition: Well.cpp:529
ome::xml::model::Well::getExternalIdentifier
ome::compat::shared_ptr< std::string > getExternalIdentifier()
Get the ExternalIdentifier property.
Definition: Well.cpp:397
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:628
ome::xml::model::Well::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Well.cpp:222
ome::xml::model::Well::getLinkedReagent
ome::compat::weak_ptr< ome::xml::model::Reagent > getLinkedReagent()
Get linked Reagent.
Definition: Well.cpp:581
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:610
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:541
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:453
ome::xml::model::Well::setRow
void setRow(const ome::xml::model::primitives::NonNegativeInteger &row)
Set the Row property.
Definition: Well.cpp:516
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::getID
const std::string & getID() const
Get the ID property.
Definition: Well.cpp:495
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:553
ome::xml::model::Well
Well model object.
Definition: Well.h:83
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:213
ome::xml::model::Well::~Well
virtual ~Well()
Destructor.
Definition: Well.cpp:208
ome::xml::model::Well::getRow
const ome::xml::model::primitives::NonNegativeInteger & getRow() const
Get the Row property.
Definition: Well.cpp:509
ome::xml::model::Well::setType
void setType(ome::compat::shared_ptr< std::string > &type)
Set the Type property.
Definition: Well.cpp:488
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:355
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:86
ome::xml::model::Well::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Well.cpp:638
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:652
ome::xml::model::Well::addWellSample
void addWellSample(ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Add WellSample.
Definition: Well.cpp:562
ome::xml::model::Well::setID
void setID(const std::string &id)
Set the ID property.
Definition: Well.cpp:502
ome::xml::model::Well::setExternalIdentifier
void setExternalIdentifier(ome::compat::shared_ptr< std::string > &externalIdentifier)
Set the ExternalIdentifier property.
Definition: Well.cpp:411
ome::xml::model::Well::getExternalDescription
ome::compat::shared_ptr< std::string > getExternalDescription()
Get the ExternalDescription property.
Definition: Well.cpp:432
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:691
ome::xml::model::Well::unlinkReagent
void unlinkReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Unlink Reagent.
Definition: Well.cpp:600
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:698
ome::xml::model::Well::setColumn
void setColumn(const ome::xml::model::primitives::NonNegativeInteger &column)
Set the Column property.
Definition: Well.cpp:425
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:229
ome::xml::model::Well::getPlate
ome::compat::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: Well.cpp:670
ome::xml::model::Well::removeWellSample
void removeWellSample(ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Remove WellSample.
Definition: Well.cpp:570
ome::xml::model::Well::getColumn
const ome::xml::model::primitives::NonNegativeInteger & getColumn() const
Get the Column property.
Definition: Well.cpp:418
ome::xml::model::Well::linkReagent
void linkReagent(ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent)
Link Reagent.
Definition: Well.cpp:594
ome::xml::model::Well::Impl
Private implementation details of Well model object.
Definition: Well.cpp:79
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:616
ome::xml::model::Well::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Well.cpp:844
log.h
ome::xml::model::Well::getType
ome::compat::shared_ptr< std::string > getType()
Get the Type property.
Definition: Well.cpp:474
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:523
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:622
ome::xml::model::Well::setColor
void setColor(ome::compat::shared_ptr< ome::xml::model::primitives::Color > &color)
Set the Color property.
Definition: Well.cpp:467
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:238
ome::xml::model::Well::Well
Well()
Default constructor.
Definition: Well.cpp:189
ome::xml::model::Well::setPlate
void setPlate(ome::compat::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: Well.cpp:684
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119