ome-xml  5.2.0
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/Experimenter.h>
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 #include <ome/xml/model/enums/ExperimentType.h>
65 
66 namespace ome
67 {
68  namespace xml
69  {
70  namespace model
71  {
72 
73  // Forward declarations.
74  class Image;
75  class MicrobeamManipulation;
76  class OMEModel;
77 
82  {
83  private:
84  class Impl;
86  ome::compat::shared_ptr<Impl> impl;
87 
88  public:
90  Experiment();
91 
97  Experiment (const Experiment& copy);
98 
100  virtual
101  ~Experiment ();
102 
117  static ome::compat::shared_ptr< Experiment>
118  create(const common::xml::dom::Element& element,
120 
121  // Documented in superclass.
122  const std::string&
123  elementName() const;
124 
125  // Documented in superclass.
126  bool
127  validElementName(const std::string& name) const;
128 
129 
130  // -- OMEModelObject API methods --
131 
133  virtual void
134  update(const common::xml::dom::Element& element,
136 
137  public:
138  // -- Experiment API methods --
139 
141  bool
142  link (ome::compat::shared_ptr<Reference>& reference,
143  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144 
150  ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>
151  getType ();
152 
158  const ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>
159  getType () const;
160 
166  void
167  setType (ome::compat::shared_ptr<ome::xml::model::enums::ExperimentType>& type);
168 
174  const std::string&
175  getID () const;
176 
182  void
183  setID (const std::string& id);
184 
190  ome::compat::shared_ptr<std::string>
191  getDescription ();
192 
198  const ome::compat::shared_ptr<std::string>
199  getDescription () const;
200 
206  void
207  setDescription (ome::compat::shared_ptr<std::string>& description);
208 
215  ome::compat::weak_ptr<ome::xml::model::Experimenter>
217 
224  const ome::compat::weak_ptr<ome::xml::model::Experimenter>
225  getLinkedExperimenter () const;
226 
232  void
233  linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
234 
244  void
245  unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
246 
252  std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type
254 
261  std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >&
263 
270  const std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >&
272 
280  ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>&
281  getMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index);
282 
290  const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>&
291  getMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index) const;
292 
300  void
301  setMicrobeamManipulation (std::vector<ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation> >::size_type index,
302  ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
303 
312  void
313  addMicrobeamManipulation (ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
314 
324  void
325  removeMicrobeamManipulation (ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
326 
333  sizeOfLinkedImageList () const;
334 
341  getLinkedImageList () const;
342 
350  const ome::compat::weak_ptr<ome::xml::model::Image>&
352 
363  const ome::compat::weak_ptr<ome::xml::model::Image>&
365  const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
366 
377  bool
378  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
379 
395  bool
396  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
397 
398 
401  asXMLElement (common::xml::dom::Document& document) const;
402 
403 
404  protected:
405  // Documented in base class.
408  common::xml::dom::Element& element) const;
409 
410  public:
411  // Documented in superclass.
412  const std::string&
413  getXMLNamespace() const;
414  };
415 
416  }
417  }
418 }
419 
420 #endif // OME_XML_MODEL_EXPERIMENT_H
421 
422 /*
423  * Local Variables:
424  * mode:C++
425  * End:
426  */
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:406
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
void addMicrobeamManipulation(ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Add MicrobeamManipulation.
Definition: Experiment.cpp:427
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Experiment.cpp:452
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:464
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:204
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:179
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Experiment.cpp:596
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 setType(ome::compat::shared_ptr< ome::xml::model::enums::ExperimentType > &type)
Set the Type property.
Definition: Experiment.cpp:317
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Experiment.cpp:372
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Experiment.cpp:195
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:277
ome::compat::shared_ptr< ome::xml::model::enums::ExperimentType > getType()
Get the Type property.
Definition: Experiment.cpp:303
const std::string & getID() const
Get the ID property.
Definition: Experiment.cpp:324
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:446
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:458
std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > >::size_type sizeOfMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Experiment.cpp:388
void removeMicrobeamManipulation(ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Remove MicrobeamManipulation.
Definition: Experiment.cpp:435
Experiment model object.
Definition: Experiment.h:81
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Experiment.cpp:338
void setID(const std::string &id)
Set the ID property.
Definition: Experiment.cpp:331
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Experiment.h:84
Open Microscopy Environment C++ implementation.
Private implementation details of Experiment model object.
Definition: Experiment.cpp:80
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Experiment.cpp:487
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Experiment.cpp:378
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Experiment.cpp:474
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Experiment.cpp:352
Experiment()
Default constructor.
Definition: Experiment.cpp:155
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Experiment.cpp:359
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:511
virtual ~Experiment()
Destructor.
Definition: Experiment.cpp:174
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:418
std::vector< ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > > & getMicrobeamManipulationList()
Get the MicrobeamManipulation list.
Definition: Experiment.cpp:394
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:504
const std::string & elementName() const
Get the element name of this model object.
Definition: Experiment.cpp:188