ome-xml 5.2.3

Experiment.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_EXPERIMENT_H
47 #define OME_XML_MODEL_EXPERIMENT_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/Experimenter.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66 #include <ome/xml/model/enums/ExperimentType.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class Image;
77 class MicrobeamManipulation;
78 class OMEModel;
79
83 class Experiment : public detail::OMEModelObject
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 Experiment();
93
99 Experiment (const Experiment& copy);
100
102 virtual
103 ~Experiment ();
104
119 static ome::compat::shared_ptr< Experiment>
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 private:
133 Experiment&
134 operator= (const Experiment&);
135
136 public:
137 // -- OMEModelObject API methods --
138
140 virtual void
141 update(const common::xml::dom::Element& element,
142 ome::xml::model::OMEModel& model);
143
144 public:
145 // -- Experiment API methods --
146
148 bool
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
151
157 ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>
158 getType ();
159
165 const ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>
166 getType () const;
167
173 void
174 setType (ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>& type);
175
181 const std::string&
182 getID () const;
183
189 void
190 setID (const std::string& id);
191
197 ome::compat::shared_ptr<std::string>
198 getDescription ();
199
205 const ome::compat::shared_ptr<std::string>
206 getDescription () const;
207
213 void
214 setDescription (ome::compat::shared_ptr<std::string>& description);
215
222 ome::compat::weak_ptr<ome::xml::model::Experimenter>
223 getLinkedExperimenter ();
224
231 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
232 getLinkedExperimenter () const;
233
239 void
240 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
241
251 void
252 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
253
259 std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type
260 sizeOfMicrobeamManipulationList () const;
261
268 std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >&
269 getMicrobeamManipulationList ();
270
277 const std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >&
278 getMicrobeamManipulationList () const;
279
287 ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>&
288 getMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index);
289
297 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>&
298 getMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index) const;
299
307 void
308 setMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index,
309 ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
310
319 void
320 addMicrobeamManipulation (ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
321
331 void
332 removeMicrobeamManipulation (ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
333
339 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type
340 sizeOfLinkedImageList () const;
341
347 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type
348 getLinkedImageList () const;
349
357 const ome::compat::weak_ptr<ome::xml::model::Image>&
358 getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index) const;
359
370 const ome::compat::weak_ptr<ome::xml::model::Image>&
371 setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
372 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
373
384 bool
385 linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
386
402 bool
403 unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
404
406 virtual common::xml::dom::Element
407 asXMLElement (common::xml::dom::Document& document) const;
408
409
410 protected:
411 // Documented in base class.
412 virtual common::xml::dom::Element
413 asXMLElementInternal (common::xml::dom::Document& document,
414 common::xml::dom::Element& element) const;
415
416 public:
417 // Documented in superclass.
418 const std::string&
419 getXMLNamespace() const;
420 };
421
422 }
423 }
424 }
425
426 #endif // OME_XML_MODEL_EXPERIMENT_H
427
428 /*
429 * Local Variables:
430 * mode:C++
431 * End:
432 */
ome::xml::model::Experiment::getMicrobeamManipulation
ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > & getMicrobeamManipulation(std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type index)
Get MicrobeamManipulation.
Definition: Experiment.cpp:402
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Experiment::addMicrobeamManipulation
void addMicrobeamManipulation(ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Add MicrobeamManipulation.
Definition: Experiment.cpp:423
ome::xml::model::Experiment::setLinkedImage
const ome::compat::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Set linked Image.
Definition: Experiment.cpp:460
ome::xml::model::Experiment::getLinkedImage
const ome::compat::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: Experiment.cpp:454
ome::xml::model::Experiment::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: Experiment.cpp:199
ome::xml::model::Experiment::getID
const std::string & getID() const
Get the ID property.
Definition: Experiment.cpp:320
ome::xml::model::Experiment::sizeOfLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Experiment.cpp:442
ome::xml::model::Experiment::create
static ome::compat::shared_ptr< Experiment > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Experiment model object from DOM element.
Definition: Experiment.cpp:175
ome::xml::model::Experiment::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Experiment.cpp:591
ome::xml::model::Experiment::getLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Experiment.cpp:448
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::Experiment::setType
void setType(ome::compat::shared_ptr< ome::xml::model::enums::ExperimentType > &type)
Set the Type property.
Definition: Experiment.cpp:313
ome::xml::model::Experiment::linkExperimenter
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Experiment.cpp:368
ome::xml::model::Experiment::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: Experiment.cpp:273
ome::xml::model::Experiment::getType
ome::compat::shared_ptr< ome::xml::model::enums::ExperimentType > getType()
Get the Type property.
Definition: Experiment.cpp:299
ome::xml::model::Experiment::removeMicrobeamManipulation
void removeMicrobeamManipulation(ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Remove MicrobeamManipulation.
Definition: Experiment.cpp:431
ome::xml::model::Experiment
Experiment model object.
Definition: Experiment.h:83
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::Experiment::sizeOfMicrobeamManipulationList
std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type sizeOfMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Experiment.cpp:384
ome::xml::model::Experiment::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Experiment.cpp:334
ome::xml::model::Experiment::setID
void setID(const std::string &id)
Set the ID property.
Definition: Experiment.cpp:327
ome::xml::model::Experiment::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Experiment.h:86
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Experiment::Impl
Private implementation details of Experiment model object.
Definition: Experiment.cpp:81
ome::xml::model::Experiment::unlinkImage
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Experiment.cpp:483
ome::xml::model::Experiment::operator=
Experiment & operator=(const Experiment &)
Assignment operator (deleted).
ome::xml::model::Experiment::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Experiment.cpp:499
ome::xml::model::Experiment::unlinkExperimenter
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Experiment.cpp:374
ome::xml::model::Experiment::linkImage
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Experiment.cpp:470
ome::xml::model::Experiment::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Experiment.cpp:348
ome::xml::model::Experiment::Experiment
Experiment()
Default constructor.
Definition: Experiment.cpp:155
ome::xml::model::Experiment::getLinkedExperimenter
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Experiment.cpp:355
ome::xml::model::Experiment::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Experiment.cpp:191
ome::xml::model::Experiment::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: Experiment.cpp:506
ome::xml::model::Experiment::~Experiment
virtual ~Experiment()
Destructor.
Definition: Experiment.cpp:170
ome::xml::model::Experiment::setMicrobeamManipulation
void setMicrobeamManipulation(std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type index, ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Set MicrobeamManipulation.
Definition: Experiment.cpp:414
ome::xml::model::Experiment::getMicrobeamManipulationList
std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > > & getMicrobeamManipulationList()
Get the MicrobeamManipulation list.
Definition: Experiment.cpp:390
log.h
ome::xml::model::Experiment::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Experiment.cpp:184