ome-xml 5.2.0

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

- File List

PlateAcquisition.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_PLATEACQUISITION_H
47 #define OME_XML_MODEL_PLATEACQUISITION_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/detail/OMEModelObject.h>
64 #include <ome/xml/model/primitives/PositiveInteger.h>
65 #include <ome/xml/model/primitives/Timestamp.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class Annotation;
76 class OMEModel;
77 class WellSample;
78
82 class PlateAcquisition : public detail::OMEModelObject
83 {
84 private:
85 class Impl;
87 ome::compat::shared_ptr<Impl> impl;
88
89 public:
91 PlateAcquisition();
92
98 PlateAcquisition (const PlateAcquisition& copy);
99
101 virtual
102 ~PlateAcquisition ();
103
118 static ome::compat::shared_ptr< PlateAcquisition>
119 create(const common::xml::dom::Element& element,
120 ome::xml::model::OMEModel& model);
121
122 // Documented in superclass.
123 const std::string&
124 elementName() const;
125
126 // Documented in superclass.
127 bool
128 validElementName(const std::string& name) const;
129
130
131 // -- OMEModelObject API methods --
132
134 virtual void
135 update(const common::xml::dom::Element& element,
136 ome::xml::model::OMEModel& model);
137
138 public:
139 // -- PlateAcquisition API methods --
140
142 bool
143 link (ome::compat::shared_ptr<Reference>& reference,
144 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
145
151 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
152 getMaximumFieldCount ();
153
159 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
160 getMaximumFieldCount () const;
161
167 void
168 setMaximumFieldCount (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& maximumFieldCount);
169
175 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
176 getEndTime ();
177
183 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
184 getEndTime () const;
185
191 void
192 setEndTime (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& endTime);
193
199 const std::string&
200 getID () const;
201
207 void
208 setID (const std::string& id);
209
215 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
216 getStartTime ();
217
223 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
224 getStartTime () const;
225
231 void
232 setStartTime (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& startTime);
233
239 ome::compat::shared_ptr<std::string>
240 getName ();
241
247 const ome::compat::shared_ptr<std::string>
248 getName () const;
249
255 void
256 setName (ome::compat::shared_ptr<std::string>& name);
257
263 ome::compat::shared_ptr<std::string>
264 getDescription ();
265
271 const ome::compat::shared_ptr<std::string>
272 getDescription () const;
273
279 void
280 setDescription (ome::compat::shared_ptr<std::string>& description);
281
287 OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type
288 sizeOfLinkedWellSampleList () const;
289
295 OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type
296 getLinkedWellSampleList () const;
297
305 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
306 getLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type index) const;
307
318 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
319 setLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type index,
320 const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
321
332 bool
333 linkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
334
350 bool
351 unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
352
358 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
359 sizeOfLinkedAnnotationList () const;
360
366 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
367 getLinkedAnnotationList () const;
368
376 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
377 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
378
389 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
390 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
391 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
392
403 bool
404 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
405
421 bool
422 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
423
429 ome::compat::weak_ptr<ome::xml::model::Plate>
430 getPlate ();
431
437 const ome::compat::weak_ptr<ome::xml::model::Plate>
438 getPlate () const;
439
445 void
446 setPlate (ome::compat::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
447
448
450 virtual common::xml::dom::Element
451 asXMLElement (common::xml::dom::Document& document) const;
452
453
454 protected:
455 // Documented in base class.
456 virtual common::xml::dom::Element
457 asXMLElementInternal (common::xml::dom::Document& document,
458 common::xml::dom::Element& element) const;
459
460 public:
461 // Documented in superclass.
462 const std::string&
463 getXMLNamespace() const;
464 };
465
466 }
467 }
468 }
469
470 #endif // OME_XML_MODEL_PLATEACQUISITION_H
471
472 /*
473 * Local Variables:
474 * mode:C++
475 * End:
476 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::PlateAcquisition::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: PlateAcquisition.cpp:481
ome::xml::model::PlateAcquisition::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: PlateAcquisition.cpp:446
ome::xml::model::PlateAcquisition::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: PlateAcquisition.cpp:460
ome::xml::model::PlateAcquisition::create
static ome::compat::shared_ptr< PlateAcquisition > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a PlateAcquisition model object from DOM element.
Definition: PlateAcquisition.cpp:195
ome::xml::model::PlateAcquisition::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: PlateAcquisition.cpp:769
ome::xml::model::PlateAcquisition::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: PlateAcquisition.cpp:322
ome::xml::model::PlateAcquisition::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: PlateAcquisition.cpp:576
ome::xml::model::PlateAcquisition::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: PlateAcquisition.cpp:554
ome::xml::model::PlateAcquisition::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: PlateAcquisition.cpp:636
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::PlateAcquisition::getMaximumFieldCount
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getMaximumFieldCount()
Get the MaximumFieldCount property.
Definition: PlateAcquisition.cpp:369
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::PlateAcquisition::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: PlateAcquisition.cpp:566
ome::xml::model::PlateAcquisition::sizeOfLinkedWellSampleList
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellSampleList() const
Get size of linked WellSample list.
Definition: PlateAcquisition.cpp:488
ome::xml::model::PlateAcquisition::getLinkedWellSampleList
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: PlateAcquisition.cpp:494
ome::xml::model::PlateAcquisition::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: PlateAcquisition.h:85
ome::xml::model::PlateAcquisition::Impl
Private implementation details of PlateAcquisition model object.
Definition: PlateAcquisition.cpp:75
ome::xml::model::PlateAcquisition::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: PlateAcquisition.cpp:204
ome::xml::model::PlateAcquisition
PlateAcquisition model object.
Definition: PlateAcquisition.h:82
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::PlateAcquisition::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: PlateAcquisition.cpp:220
ome::xml::model::PlateAcquisition::setStartTime
void setStartTime(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &startTime)
Set the StartTime property.
Definition: PlateAcquisition.cpp:439
ome::xml::model::PlateAcquisition::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: PlateAcquisition.cpp:548
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::PlateAcquisition::linkWellSample
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Link WellSample.
Definition: PlateAcquisition.cpp:516
ome::xml::model::PlateAcquisition::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: PlateAcquisition.cpp:560
ome::xml::model::PlateAcquisition::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: PlateAcquisition.cpp:467
ome::xml::model::PlateAcquisition::setID
void setID(const std::string &id)
Set the ID property.
Definition: PlateAcquisition.cpp:418
ome::xml::model::PlateAcquisition::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: PlateAcquisition.cpp:590
ome::xml::model::PlateAcquisition::getPlate
ome::compat::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: PlateAcquisition.cpp:608
ome::xml::model::PlateAcquisition::setMaximumFieldCount
void setMaximumFieldCount(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &maximumFieldCount)
Set the MaximumFieldCount property.
Definition: PlateAcquisition.cpp:383
ome::xml::model::PlateAcquisition::getID
const std::string & getID() const
Get the ID property.
Definition: PlateAcquisition.cpp:411
ome::xml::model::PlateAcquisition::unlinkWellSample
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Unlink WellSample.
Definition: PlateAcquisition.cpp:530
ome::xml::model::PlateAcquisition::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: PlateAcquisition.cpp:629
ome::xml::model::PlateAcquisition::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: PlateAcquisition.cpp:211
ome::xml::model::PlateAcquisition::setPlate
void setPlate(ome::compat::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: PlateAcquisition.cpp:622
ome::xml::model::PlateAcquisition::getLinkedWellSample
const ome::compat::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index) const
Get linked WellSample.
Definition: PlateAcquisition.cpp:500
log.h
ome::xml::model::PlateAcquisition::setLinkedWellSample
const ome::compat::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Set linked WellSample.
Definition: PlateAcquisition.cpp:506
ome::xml::model::PlateAcquisition::setEndTime
void setEndTime(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &endTime)
Set the EndTime property.
Definition: PlateAcquisition.cpp:404
ome::xml::model::PlateAcquisition::getStartTime
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getStartTime()
Get the StartTime property.
Definition: PlateAcquisition.cpp:425
ome::xml::model::PlateAcquisition::getEndTime
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getEndTime()
Get the EndTime property.
Definition: PlateAcquisition.cpp:390
ome::xml::model::PlateAcquisition::~PlateAcquisition
virtual ~PlateAcquisition()
Destructor.
Definition: PlateAcquisition.cpp:190
ome::xml::model::PlateAcquisition::PlateAcquisition
PlateAcquisition()
Default constructor.
Definition: PlateAcquisition.cpp:171