bioformats  5.1.0
ROI.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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_ROI_H
47 #define OME_XML_MODEL_ROI_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/Union.h>
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class Annotation;
74  class Image;
75  class MicrobeamManipulation;
76  class OMEModel;
77 
81  class ROI : public detail::OMEModelObject
82  {
83  private:
85  ome::compat::shared_ptr<std::string> namespace_;
87  std::string id;
89  ome::compat::shared_ptr<std::string> name;
91  ome::compat::shared_ptr<ome::xml::model::Union> union_;
95  ome::compat::shared_ptr<std::string> description;
100 
101  public:
103  ROI ();
104 
110  ROI (const ROI& copy);
111 
113  virtual
114  ~ROI ();
115 
116 
117 
132  static ome::compat::shared_ptr< ROI>
133  create(const common::xml::dom::Element& element,
135 
136  // Documented in superclass.
137  const std::string&
138  elementName() const;
139 
140  // Documented in superclass.
141  bool
142  validElementName(const std::string& name) const;
143 
144 
145  // -- OMEModelObject API methods --
146 
148  virtual void
149  update(const common::xml::dom::Element& element,
151 
152  public:
153  // -- ROI API methods --
154 
156  bool
157  link (ome::compat::shared_ptr<Reference>& reference,
158  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
159 
165  ome::compat::shared_ptr<std::string>
166  getNamespace ();
167 
173  const ome::compat::shared_ptr<std::string>
174  getNamespace () const;
175 
181  void
182  setNamespace (ome::compat::shared_ptr<std::string>& namespace_);
183 
189  const std::string&
190  getID () const;
191 
197  void
198  setID (const std::string& id);
199 
205  ome::compat::shared_ptr<std::string>
206  getName ();
207 
213  const ome::compat::shared_ptr<std::string>
214  getName () const;
215 
221  void
222  setName (ome::compat::shared_ptr<std::string>& name);
223 
229  ome::compat::shared_ptr<ome::xml::model::Union>
230  getUnion ();
231 
237  const ome::compat::shared_ptr<ome::xml::model::Union>
238  getUnion () const;
239 
245  void
246  setUnion (ome::compat::shared_ptr<ome::xml::model::Union>& union_);
247 
255 
262  getLinkedAnnotationList () const;
263 
271  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
273 
284  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
286  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
287 
298  bool
299  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
300 
316  bool
317  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
318 
324  ome::compat::shared_ptr<std::string>
325  getDescription ();
326 
332  const ome::compat::shared_ptr<std::string>
333  getDescription () const;
334 
340  void
341  setDescription (ome::compat::shared_ptr<std::string>& description);
342 
349  sizeOfLinkedImageList () const;
350 
357  getLinkedImageList () const;
358 
366  const ome::compat::weak_ptr<ome::xml::model::Image>&
368 
379  const ome::compat::weak_ptr<ome::xml::model::Image>&
381  const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
382 
393  bool
394  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
395 
411  bool
412  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
413 
421 
429 
437  const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
439 
450  const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
452  const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
453 
464  bool
465  linkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
466 
482  bool
483  unlinkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
484 
485 
488  asXMLElement (common::xml::dom::Document& document) const;
489 
490 
491  protected:
492  // Documented in base class.
495  common::xml::dom::Element& element) const;
496 
497  public:
498  // Documented in superclass.
499  const std::string&
500  getXMLNamespace() const;
501  };
502 
503  }
504  }
505 }
506 
507 #endif // OME_XML_MODEL_ROI_H
508 
509 /*
510  * Local Variables:
511  * mode:C++
512  * End:
513  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual ~ROI()
Destructor.
Definition: ROI.cpp:172
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: ROI.cpp:543
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: ROI.cpp:202
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: ROI.cpp:410
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: ROI.cpp:404
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: ROI.cpp:440
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: ROI.cpp:426
std::string id
ID property.
Definition: ROI.h:87
const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > & setLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Set linked MicrobeamManipulation.
Definition: ROI.cpp:555
ome::compat::shared_ptr< ome::xml::model::Union > union_
Union property.
Definition: ROI.h:91
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ROI.cpp:193
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: ROI.cpp:458
void setNamespace(ome::compat::shared_ptr< std::string > &namespace_)
Set the Namespace property.
Definition: ROI.cpp:335
ROI model object.
Definition: ROI.h:81
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Unlink MicrobeamManipulation.
Definition: ROI.cpp:578
DOM Document wrapper.
Definition: Document.h:80
const std::string & getID() const
Get the ID property.
Definition: ROI.cpp:342
DOM Element wrapper.
Definition: Element.h:66
static ome::compat::shared_ptr< ROI > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a ROI model object from DOM element.
Definition: ROI.cpp:177
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type imageLinks
Image_BackReference back reference (occurs more than once)
Definition: ROI.h:97
const std::string & elementName() const
Get the element name of this model object.
Definition: ROI.cpp:186
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
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Link MicrobeamManipulation.
Definition: ROI.cpp:565
const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > & getLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type index) const
Get linked MicrobeamManipulation.
Definition: ROI.cpp:549
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: ROI.cpp:398
void setID(const std::string &id)
Set the ID property.
Definition: ROI.cpp:349
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: ROI.h:93
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: ROI.cpp:507
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::compat::shared_ptr< std::string > getNamespace()
Get the Namespace property.
Definition: ROI.cpp:321
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ROI.cpp:700
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
ome::compat::shared_ptr< ome::xml::model::Union > getUnion()
Get the Union property.
Definition: ROI.cpp:377
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: ROI.cpp:290
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: ROI.cpp:497
void setUnion(ome::compat::shared_ptr< ome::xml::model::Union > &union_)
Set the Union property.
Definition: ROI.cpp:391
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: ROI.cpp:472
ome::compat::shared_ptr< std::string > name
Name property.
Definition: ROI.h:89
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: ROI.cpp:602
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: ROI.cpp:537
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: ROI.cpp:356
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: ROI.cpp:416
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: ROI.cpp:520
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: ROI.cpp:370
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type microbeamManipulationLinks
MicrobeamManipulation_BackReference back reference (occurs more than once)
Definition: ROI.h:99
ome::compat::shared_ptr< std::string > namespace_
Namespace property.
Definition: ROI.h:85
ome::compat::shared_ptr< std::string > description
Description property.
Definition: ROI.h:95
ROI()
Default constructor.
Definition: ROI.cpp:139
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: ROI.cpp:485
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: ROI.cpp:491
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: ROI.cpp:595
Boost.Log compatibility.
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: ROI.cpp:479
Xerces-C modern C++ wrapper.
Definition: Base.h:53