ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Plate.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66 #include <ome/xml/model/primitives/PositiveInteger.h>
67 #include <ome/xml/model/primitives/Timestamp.h>
68
69 namespace ome
70 {
71 namespace xml
72 {
73 namespace model
74 {
75
76 // Forward declarations.
77 class Annotation;
78 class OMEModel;
79 class WellSample;
80
84 class PlateAcquisition : public detail::OMEModelObject
85 {
86 private:
87 class Impl;
89 ome::compat::shared_ptr<Impl> impl;
90
91 public:
93 PlateAcquisition();
94
100 PlateAcquisition (const PlateAcquisition& copy);
101
103 virtual
104 ~PlateAcquisition ();
105
120 static ome::compat::shared_ptr< PlateAcquisition>
121 create(const common::xml::dom::Element& element,
122 ome::xml::model::OMEModel& model);
123
124 // Documented in superclass.
125 const std::string&
126 elementName() const;
127
128 // Documented in superclass.
129 bool
130 validElementName(const std::string& name) const;
131
132 private:
134 PlateAcquisition&
135 operator= (const PlateAcquisition&);
136
137 public:
138 // -- OMEModelObject API methods --
139
141 virtual void
142 update(const common::xml::dom::Element& element,
143 ome::xml::model::OMEModel& model);
144
145 public:
146 // -- PlateAcquisition API methods --
147
149 bool
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152
158 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
159 getMaximumFieldCount ();
160
166 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
167 getMaximumFieldCount () const;
168
174 void
175 setMaximumFieldCount (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& maximumFieldCount);
176
182 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
183 getEndTime ();
184
190 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
191 getEndTime () const;
192
198 void
199 setEndTime (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& endTime);
200
206 const std::string&
207 getID () const;
208
214 void
215 setID (const std::string& id);
216
222 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
223 getStartTime ();
224
230 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
231 getStartTime () const;
232
238 void
239 setStartTime (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& startTime);
240
246 ome::compat::shared_ptr<std::string>
247 getName ();
248
254 const ome::compat::shared_ptr<std::string>
255 getName () const;
256
262 void
263 setName (ome::compat::shared_ptr<std::string>& name);
264
270 ome::compat::shared_ptr<std::string>
271 getDescription ();
272
278 const ome::compat::shared_ptr<std::string>
279 getDescription () const;
280
286 void
287 setDescription (ome::compat::shared_ptr<std::string>& description);
288
294 OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type
295 sizeOfLinkedWellSampleList () const;
296
302 OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type
303 getLinkedWellSampleList () const;
304
312 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
313 getLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type index) const;
314
325 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
326 setLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type index,
327 const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
328
339 bool
340 linkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
341
357 bool
358 unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample);
359
365 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
366 sizeOfLinkedAnnotationList () const;
367
373 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
374 getLinkedAnnotationList () const;
375
383 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
384 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
385
396 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
397 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
398 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
399
410 bool
411 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
412
428 bool
429 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
430
436 ome::compat::weak_ptr<ome::xml::model::Plate>
437 getPlate ();
438
444 const ome::compat::weak_ptr<ome::xml::model::Plate>
445 getPlate () const;
446
452 void
453 setPlate (ome::compat::weak_ptr<ome::xml::model::Plate>& plate_BackReference);
454
456 virtual common::xml::dom::Element
457 asXMLElement (common::xml::dom::Document& document) const;
458
459
460 protected:
461 // Documented in base class.
462 virtual common::xml::dom::Element
463 asXMLElementInternal (common::xml::dom::Document& document,
464 common::xml::dom::Element& element) const;
465
466 public:
467 // Documented in superclass.
468 const std::string&
469 getXMLNamespace() const;
470 };
471
472 }
473 }
474 }
475
476 #endif // OME_XML_MODEL_PLATEACQUISITION_H
477
478 /*
479 * Local Variables:
480 * mode:C++
481 * End:
482 */
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:476
ome::xml::model::PlateAcquisition::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: PlateAcquisition.cpp:441
ome::xml::model::PlateAcquisition::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: PlateAcquisition.cpp:455
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:543
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:190
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:317
ome::xml::model::PlateAcquisition::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: PlateAcquisition.cpp:571
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::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: PlateAcquisition.cpp:549
ome::xml::model::PlateAcquisition::getMaximumFieldCount
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getMaximumFieldCount()
Get the MaximumFieldCount property.
Definition: PlateAcquisition.cpp:364
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:561
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:555
ome::xml::model::PlateAcquisition::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: PlateAcquisition.h:87
ome::xml::model::PlateAcquisition::Impl
Private implementation details of PlateAcquisition model object.
Definition: PlateAcquisition.cpp:75
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:206
ome::xml::model::PlateAcquisition
PlateAcquisition model object.
Definition: PlateAcquisition.h:84
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:495
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:483
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:214
ome::xml::model::PlateAcquisition::setStartTime
void setStartTime(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &startTime)
Set the StartTime property.
Definition: PlateAcquisition.cpp:434
ome
Open Microscopy Environment C++ implementation.
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:623
ome::xml::model::PlateAcquisition::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: PlateAcquisition.cpp:763
ome::xml::model::PlateAcquisition::linkWellSample
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Link WellSample.
Definition: PlateAcquisition.cpp:511
ome::xml::model::PlateAcquisition::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: PlateAcquisition.cpp:462
ome::xml::model::PlateAcquisition::setID
void setID(const std::string &id)
Set the ID property.
Definition: PlateAcquisition.cpp:413
ome::xml::model::PlateAcquisition::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: PlateAcquisition.cpp:585
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:630
ome::xml::model::PlateAcquisition::getPlate
ome::compat::weak_ptr< ome::xml::model::Plate > getPlate()
Get the Plate property.
Definition: PlateAcquisition.cpp:603
ome::xml::model::PlateAcquisition::getID
const std::string & getID() const
Get the ID property.
Definition: PlateAcquisition.cpp:406
ome::xml::model::PlateAcquisition::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: PlateAcquisition.cpp:199
ome::xml::model::PlateAcquisition::setMaximumFieldCount
void setMaximumFieldCount(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &maximumFieldCount)
Set the MaximumFieldCount property.
Definition: PlateAcquisition.cpp:378
ome::xml::model::PlateAcquisition::unlinkWellSample
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample)
Unlink WellSample.
Definition: PlateAcquisition.cpp:525
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:489
ome::xml::model::PlateAcquisition::operator=
PlateAcquisition & operator=(const PlateAcquisition &)
Assignment operator (deleted).
ome::xml::model::PlateAcquisition::setPlate
void setPlate(ome::compat::weak_ptr< ome::xml::model::Plate > &plate_BackReference)
Set the Plate property.
Definition: PlateAcquisition.cpp:617
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:501
ome::xml::model::PlateAcquisition::setEndTime
void setEndTime(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &endTime)
Set the EndTime property.
Definition: PlateAcquisition.cpp:399
ome::xml::model::PlateAcquisition::getStartTime
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getStartTime()
Get the StartTime property.
Definition: PlateAcquisition.cpp:420
log.h
ome::xml::model::PlateAcquisition::getEndTime
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getEndTime()
Get the EndTime property.
Definition: PlateAcquisition.cpp:385
ome::xml::model::PlateAcquisition::~PlateAcquisition
virtual ~PlateAcquisition()
Destructor.
Definition: PlateAcquisition.cpp:185
ome::xml::model::PlateAcquisition::PlateAcquisition
PlateAcquisition()
Default constructor.
Definition: PlateAcquisition.cpp:170