ome-xml  5.2.0
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/Experiment.h>
63 #include <ome/xml/model/Experimenter.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 #include <ome/xml/model/enums/MicrobeamManipulationType.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class Image;
76  class LightSourceSettings;
77  class OMEModel;
78  class ROI;
79 
84  {
85  private:
86  class Impl;
88  ome::compat::shared_ptr<Impl> impl;
89 
90  public:
93 
100 
102  virtual
104 
119  static ome::compat::shared_ptr< MicrobeamManipulation>
120  create(const common::xml::dom::Element& element,
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,
138 
139  public:
140  // -- MicrobeamManipulation 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<ome::xml::model::enums::MicrobeamManipulationType>
153  getType ();
154 
160  const ome::compat::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>
161  getType () const;
162 
168  void
169  setType (ome::compat::shared_ptr<ome::xml::model::enums::MicrobeamManipulationType>& type);
170 
176  const std::string&
177  getID () const;
178 
184  void
185  setID (const std::string& id);
186 
192  ome::compat::shared_ptr<std::string>
193  getDescription ();
194 
200  const ome::compat::shared_ptr<std::string>
201  getDescription () const;
202 
208  void
209  setDescription (ome::compat::shared_ptr<std::string>& description);
210 
217  sizeOfLinkedROIList () const;
218 
225  getLinkedROIList () const;
226 
234  const ome::compat::weak_ptr<ome::xml::model::ROI>&
236 
247  const ome::compat::weak_ptr<ome::xml::model::ROI>&
249  const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
250 
261  bool
262  linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
263 
279  bool
280  unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
281 
288  ome::compat::weak_ptr<ome::xml::model::Experimenter>
290 
297  const ome::compat::weak_ptr<ome::xml::model::Experimenter>
298  getLinkedExperimenter () const;
299 
305  void
306  linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
307 
317  void
318  unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
319 
325  std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type
327 
334  std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >&
336 
343  const std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >&
345 
353  ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>&
354  getLightSourceSettings (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type index);
355 
363  const ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>&
364  getLightSourceSettings (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type index) const;
365 
373  void
374  setLightSourceSettings (std::vector<ome::compat::shared_ptr<ome::xml::model::LightSourceSettings> >::size_type index,
375  ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
376 
385  void
386  addLightSourceSettings (ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
387 
397  void
398  removeLightSourceSettings (ome::compat::shared_ptr<ome::xml::model::LightSourceSettings>& lightSourceSettings);
399 
406  sizeOfLinkedImageList () const;
407 
414  getLinkedImageList () const;
415 
423  const ome::compat::weak_ptr<ome::xml::model::Image>&
425 
436  const ome::compat::weak_ptr<ome::xml::model::Image>&
438  const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
439 
450  bool
451  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
452 
468  bool
469  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
470 
476  ome::compat::weak_ptr<ome::xml::model::Experiment>
477  getExperiment ();
478 
484  const ome::compat::weak_ptr<ome::xml::model::Experiment>
485  getExperiment () const;
486 
492  void
493  setExperiment (ome::compat::weak_ptr<ome::xml::model::Experiment>& experiment_BackReference);
494 
495 
498  asXMLElement (common::xml::dom::Document& document) const;
499 
500 
501  protected:
502  // Documented in base class.
505  common::xml::dom::Element& element) const;
506 
507  public:
508  // Documented in superclass.
509  const std::string&
510  getXMLNamespace() const;
511  };
512 
513  }
514  }
515 }
516 
517 #endif // OME_XML_MODEL_MICROBEAMMANIPULATION_H
518 
519 /*
520  * Local Variables:
521  * mode:C++
522  * End:
523  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::weak_ptr< ome::xml::model::Experiment > getExperiment()
Get the Experiment property.
Definition: MicrobeamManipulation.cpp:605
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:507
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: MicrobeamManipulation.cpp:428
void setExperiment(ome::compat::weak_ptr< ome::xml::model::Experiment > &experiment_BackReference)
Set the Experiment property.
Definition: MicrobeamManipulation.cpp:619
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > > & getLightSourceSettingsList()
Get the LightSourceSettings list.
Definition: MicrobeamManipulation.cpp:495
const std::string & getID() const
Get the ID property.
Definition: MicrobeamManipulation.cpp:365
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: MicrobeamManipulation.cpp:479
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:418
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:633
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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
void removeLightSourceSettings(ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Remove LightSourceSettings.
Definition: MicrobeamManipulation.cpp:536
virtual ~MicrobeamManipulation()
Destructor.
Definition: MicrobeamManipulation.cpp:187
ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > getType()
Get the Type property.
Definition: MicrobeamManipulation.cpp:344
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:412
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
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:302
Open Microscopy Environment C++ implementation.
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: MicrobeamManipulation.cpp:442
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: MicrobeamManipulation.cpp:208
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: MicrobeamManipulation.cpp:588
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: MicrobeamManipulation.cpp:460
MicrobeamManipulation()
Default constructor.
Definition: MicrobeamManipulation.cpp:168
MicrobeamManipulation model object.
Definition: MicrobeamManipulation.h:83
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:565
std::vector< ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > >::size_type sizeOfLightSourceSettingsList() const
Get size of linked LightSourceSettings list.
Definition: MicrobeamManipulation.cpp:489
const std::string & elementName() const
Get the element name of this model object.
Definition: MicrobeamManipulation.cpp:201
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: MicrobeamManipulation.cpp:406
void addLightSourceSettings(ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
Add LightSourceSettings.
Definition: MicrobeamManipulation.cpp:528
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:626
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: MicrobeamManipulation.cpp:742
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:192
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: MicrobeamManipulation.cpp:553
void setType(ome::compat::shared_ptr< ome::xml::model::enums::MicrobeamManipulationType > &type)
Set the Type property.
Definition: MicrobeamManipulation.cpp:358
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:547
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:559
Private implementation details of MicrobeamManipulation model object.
Definition: MicrobeamManipulation.cpp:79
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:519
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:400
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: MicrobeamManipulation.cpp:393
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:217
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: MicrobeamManipulation.h:86
void setID(const std::string &id)
Set the ID property.
Definition: MicrobeamManipulation.cpp:372
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: MicrobeamManipulation.cpp:575
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: MicrobeamManipulation.cpp:473
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: MicrobeamManipulation.cpp:379