ome-xml 5.2.3

MicrobeamManipulation.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_MICROBEAMMANIPULATION_H
47 #define OME_XML_MODEL_MICROBEAMMANIPULATION_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/Experiment.h>
65 #include <ome/xml/model/Experimenter.h>
66 #include <ome/xml/model/detail/OMEModelObject.h>
67 #include <ome/xml/model/enums/MicrobeamManipulationType.h>
68
69 namespace ome
70 {
71 namespace xml
72 {
73 namespace model
74 {
75
76 // Forward declarations.
77 class Image;
78 class LightSourceSettings;
79 class OMEModel;
80 class ROI;
81
85 class MicrobeamManipulation : public detail::OMEModelObject
86 {
87 private:
88 class Impl;
90 ome::compat::shared_ptr<Impl> impl;
91
92 public:
94 MicrobeamManipulation();
95
101 MicrobeamManipulation (const MicrobeamManipulation& copy);
102
104 virtual
105 ~MicrobeamManipulation ();
106
121 static ome::compat::shared_ptr< MicrobeamManipulation>
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 MicrobeamManipulation&
136 operator= (const MicrobeamManipulation&);
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 // -- MicrobeamManipulation 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<ome::xml::model::enums::MicrobeamManipulationType>
160 getType ();
161
167 const ome::compat::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>
168 getType () const;
169
175 void
176 setType (ome::compat::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>& type);
177
183 const std::string&
184 getID () const;
185
191 void
192 setID (const std::string& id);
193
199 ome::compat::shared_ptr<std::string>
200 getDescription ();
201
207 const ome::compat::shared_ptr<std::string>
208 getDescription () const;
209
215 void
216 setDescription (ome::compat::shared_ptr<std::string>& description);
217
223 OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type::size_type
224 sizeOfLinkedROIList () const;
225
231 OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type
232 getLinkedROIList () const;
233
241 const ome::compat::weak_ptr<ome::xml::model::ROI>&
242 getLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type::size_type index) const;
243
254 const ome::compat::weak_ptr<ome::xml::model::ROI>&
255 setLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type::size_type index,
256 const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
257
268 bool
269 linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
270
286 bool
287 unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
288
295 ome::compat::weak_ptr<ome::xml::model::Experimenter>
296 getLinkedExperimenter ();
297
304 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
305 getLinkedExperimenter () const;
306
312 void
313 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
314
324 void
325 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
326
332 std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type
333 sizeOfLightSourceSettingsList () const;
334
341 std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >&
342 getLightSourceSettingsList ();
343
350 const std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >&
351 getLightSourceSettingsList () const;
352
360 ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>&
361 getLightSourceSettings (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type index);
362
370 const ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>&
371 getLightSourceSettings (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type index) const;
372
380 void
381 setLightSourceSettings (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type index,
382 ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
383
392 void
393 addLightSourceSettings (ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
394
404 void
405 removeLightSourceSettings (ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
406
412 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type
413 sizeOfLinkedImageList () const;
414
420 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type
421 getLinkedImageList () const;
422
430 const ome::compat::weak_ptr<ome::xml::model::Image>&
431 getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index) const;
432
443 const ome::compat::weak_ptr<ome::xml::model::Image>&
444 setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
445 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
446
457 bool
458 linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
459
475 bool
476 unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
477
483 ome::compat::weak_ptr<ome::xml::model::Experiment>
484 getExperiment ();
485
491 const ome::compat::weak_ptr<ome::xml::model::Experiment>
492 getExperiment () const;
493
499 void
500 setExperiment (ome::compat::weak_ptr<ome::xml::model::Experiment>& experiment_BackReference);
501
503 virtual common::xml::dom::Element
504 asXMLElement (common::xml::dom::Document& document) const;
505
506
507 protected:
508 // Documented in base class.
509 virtual common::xml::dom::Element
510 asXMLElementInternal (common::xml::dom::Document& document,
511 common::xml::dom::Element& element) const;
512
513 public:
514 // Documented in superclass.
515 const std::string&
516 getXMLNamespace() const;
517 };
518
519 }
520 }
521 }
522
523 #endif // OME_XML_MODEL_MICROBEAMMANIPULATION_H
524
525 /*
526 * Local Variables:
527 * mode:C++
528 * End:
529 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::MicrobeamManipulation::getExperiment
ome::compat::weak_ptr< ome::xml::model::Experiment > getExperiment()
Get the Experiment property.
Definition: MicrobeamManipulation.cpp:601
ome::xml::model::MicrobeamManipulation::getLightSourceSettings
ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > & getLightSourceSettings(std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type index)
Get LightSourceSettings.
Definition: MicrobeamManipulation.cpp:503
ome::xml::model::MicrobeamManipulation::getID
const std::string & getID() const
Get the ID property.
Definition: MicrobeamManipulation.cpp:361
ome::xml::model::MicrobeamManipulation::getLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: MicrobeamManipulation.cpp:549
ome::xml::model::MicrobeamManipulation::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: MicrobeamManipulation.cpp:628
ome::xml::model::MicrobeamManipulation::linkROI
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: MicrobeamManipulation.cpp:424
ome::xml::model::MicrobeamManipulation::setExperiment
void setExperiment(ome::compat::weak_ptr< ome::xml::model::Experiment > &experiment_BackReference)
Set the Experiment property.
Definition: MicrobeamManipulation.cpp:615
ome::xml::model::MicrobeamManipulation::getLightSourceSettingsList
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > > & getLightSourceSettingsList()
Get the LightSourceSettings list.
Definition: MicrobeamManipulation.cpp:491
ome::xml::model::MicrobeamManipulation::sizeOfLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: MicrobeamManipulation.cpp:543
ome::xml::model::MicrobeamManipulation::getLinkedROI
const ome::compat::weak_ptr< ome::xml::model::ROI > & getLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index) const
Get linked ROI.
Definition: MicrobeamManipulation.cpp:408
ome::xml::model::MicrobeamManipulation::unlinkExperimenter
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: MicrobeamManipulation.cpp:475
ome::common::xml::dom::Document
ome::xml::model::MicrobeamManipulation::setLinkedROI
const ome::compat::weak_ptr< ome::xml::model::ROI > & setLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Set linked ROI.
Definition: MicrobeamManipulation.cpp:414
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::MicrobeamManipulation::removeLightSourceSettings
void removeLightSourceSettings(ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Remove LightSourceSettings.
Definition: MicrobeamManipulation.cpp:532
ome::xml::model::MicrobeamManipulation::~MicrobeamManipulation
virtual ~MicrobeamManipulation()
Destructor.
Definition: MicrobeamManipulation.cpp:183
ome::xml::model::MicrobeamManipulation::getType
ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > getType()
Get the Type property.
Definition: MicrobeamManipulation.cpp:340
ome::xml::model::MicrobeamManipulation::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: MicrobeamManipulation.cpp:555
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::MicrobeamManipulation::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: MicrobeamManipulation.cpp:298
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::MicrobeamManipulation::unlinkROI
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: MicrobeamManipulation.cpp:438
ome::xml::model::MicrobeamManipulation::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: MicrobeamManipulation.cpp:197
ome::xml::model::MicrobeamManipulation::unlinkImage
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: MicrobeamManipulation.cpp:584
ome::xml::model::MicrobeamManipulation::getLinkedExperimenter
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: MicrobeamManipulation.cpp:456
ome::xml::model::MicrobeamManipulation::sizeOfLinkedROIList
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: MicrobeamManipulation.cpp:396
ome::xml::model::MicrobeamManipulation::MicrobeamManipulation
MicrobeamManipulation()
Default constructor.
Definition: MicrobeamManipulation.cpp:168
ome::xml::model::MicrobeamManipulation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: MicrobeamManipulation.cpp:204
ome::xml::model::MicrobeamManipulation
MicrobeamManipulation model object.
Definition: MicrobeamManipulation.h:85
ome::xml::model::MicrobeamManipulation::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: MicrobeamManipulation.cpp:561
ome::xml::model::MicrobeamManipulation::getLinkedROIList
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: MicrobeamManipulation.cpp:402
ome::xml::model::MicrobeamManipulation::addLightSourceSettings
void addLightSourceSettings(ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Add LightSourceSettings.
Definition: MicrobeamManipulation.cpp:524
ome::xml::model::MicrobeamManipulation::create
static ome::compat::shared_ptr< MicrobeamManipulation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a MicrobeamManipulation model object from DOM element.
Definition: MicrobeamManipulation.cpp:188
ome::xml::model::MicrobeamManipulation::setType
void setType(ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > &type)
Set the Type property.
Definition: MicrobeamManipulation.cpp:354
ome::xml::model::MicrobeamManipulation::Impl
Private implementation details of MicrobeamManipulation model object.
Definition: MicrobeamManipulation.cpp:80
ome::xml::model::MicrobeamManipulation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: MicrobeamManipulation.cpp:737
ome::xml::model::MicrobeamManipulation::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: MicrobeamManipulation.cpp:621
ome::xml::model::MicrobeamManipulation::setLightSourceSettings
void setLightSourceSettings(std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type index, ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Set LightSourceSettings.
Definition: MicrobeamManipulation.cpp:515
ome::xml::model::MicrobeamManipulation::sizeOfLightSourceSettingsList
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type sizeOfLightSourceSettingsList() const
Get size of linked LightSourceSettings list.
Definition: MicrobeamManipulation.cpp:485
ome::xml::model::MicrobeamManipulation::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: MicrobeamManipulation.cpp:389
ome::xml::model::MicrobeamManipulation::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: MicrobeamManipulation.cpp:212
log.h
ome::xml::model::MicrobeamManipulation::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: MicrobeamManipulation.h:88
ome::xml::model::MicrobeamManipulation::operator=
MicrobeamManipulation & operator=(const MicrobeamManipulation &)
Assignment operator (deleted).
ome::xml::model::MicrobeamManipulation::setID
void setID(const std::string &id)
Set the ID property.
Definition: MicrobeamManipulation.cpp:368
ome::xml::model::MicrobeamManipulation::linkImage
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: MicrobeamManipulation.cpp:571
ome::xml::model::MicrobeamManipulation::linkExperimenter
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: MicrobeamManipulation.cpp:469
ome::xml::model::MicrobeamManipulation::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: MicrobeamManipulation.cpp:375