ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

ROI.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_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:
84 class Impl;
86 ome::compat::shared_ptr<Impl> impl;
87
88 public:
90 ROI();
91
97 ROI (const ROI& copy);
98
100 virtual
101 ~ROI ();
102
117 static ome::compat::shared_ptr< ROI>
118 create(const common::xml::dom::Element& element,
119 ome::xml::model::OMEModel& model);
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,
135 ome::xml::model::OMEModel& model);
136
137 public:
138 // -- ROI 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<std::string>
151 getNamespace ();
152
158 const ome::compat::shared_ptr<std::string>
159 getNamespace () const;
160
166 void
167 setNamespace (ome::compat::shared_ptr<std::string>& namespace_);
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 getName ();
192
198 const ome::compat::shared_ptr<std::string>
199 getName () const;
200
206 void
207 setName (ome::compat::shared_ptr<std::string>& name);
208
214 ome::compat::shared_ptr<ome::xml::model::Union>
215 getUnion ();
216
222 const ome::compat::shared_ptr<ome::xml::model::Union>
223 getUnion () const;
224
230 void
231 setUnion (ome::compat::shared_ptr<ome::xml::model::Union>& union_);
232
238 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
239 sizeOfLinkedAnnotationList () const;
240
246 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
247 getLinkedAnnotationList () const;
248
256 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
257 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
258
269 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
270 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
271 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
272
283 bool
284 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
285
301 bool
302 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
303
309 ome::compat::shared_ptr<std::string>
310 getDescription ();
311
317 const ome::compat::shared_ptr<std::string>
318 getDescription () const;
319
325 void
326 setDescription (ome::compat::shared_ptr<std::string>& description);
327
333 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type
334 sizeOfLinkedImageList () const;
335
341 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type
342 getLinkedImageList () const;
343
351 const ome::compat::weak_ptr<ome::xml::model::Image>&
352 getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index) const;
353
364 const ome::compat::weak_ptr<ome::xml::model::Image>&
365 setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
366 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
367
378 bool
379 linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
380
396 bool
397 unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
398
404 OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type
405 sizeOfLinkedMicrobeamManipulationList () const;
406
412 OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type
413 getLinkedMicrobeamManipulationList () const;
414
422 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
423 getLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type index) const;
424
435 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
436 setLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type index,
437 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
438
449 bool
450 linkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
451
467 bool
468 unlinkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
469
470
472 virtual common::xml::dom::Element
473 asXMLElement (common::xml::dom::Document& document) const;
474
475
476 protected:
477 // Documented in base class.
478 virtual common::xml::dom::Element
479 asXMLElementInternal (common::xml::dom::Document& document,
480 common::xml::dom::Element& element) const;
481
482 public:
483 // Documented in superclass.
484 const std::string&
485 getXMLNamespace() const;
486 };
487
488 }
489 }
490 }
491
492 #endif // OME_XML_MODEL_ROI_H
493
494 /*
495 * Local Variables:
496 * mode:C++
497 * End:
498 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::ROI::~ROI
virtual ~ROI()
Destructor.
Definition: ROI.cpp:201
ome::xml::model::ROI::getLinkedMicrobeamManipulationList
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: ROI.cpp:572
ome::xml::model::ROI::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: ROI.cpp:231
ome::xml::model::ROI::getLinkedAnnotation
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:439
ome::xml::model::ROI::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: ROI.cpp:433
ome::xml::model::ROI::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: ROI.cpp:469
ome::xml::model::ROI::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: ROI.cpp:455
ome::xml::model::ROI::setLinkedMicrobeamManipulation
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:584
ome::xml::model::ROI::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ROI.cpp:222
ome::xml::model::ROI::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: ROI.cpp:487
ome::xml::model::ROI::setNamespace
void setNamespace(ome::compat::shared_ptr< std::string > &namespace_)
Set the Namespace property.
Definition: ROI.cpp:364
ome::xml::model::ROI
ROI model object.
Definition: ROI.h:81
ome::xml::model::ROI::unlinkMicrobeamManipulation
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Unlink MicrobeamManipulation.
Definition: ROI.cpp:607
ome::common::xml::dom::Document
ome::xml::model::ROI::getID
const std::string & getID() const
Get the ID property.
Definition: ROI.cpp:371
ome::common::xml::dom::Element
ome::xml::model::ROI::create
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:206
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::ROI::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: ROI.cpp:215
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::ROI::linkMicrobeamManipulation
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Link MicrobeamManipulation.
Definition: ROI.cpp:594
ome::xml::model::ROI::getLinkedMicrobeamManipulation
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:578
ome::xml::model::ROI::sizeOfLinkedAnnotationList
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:427
ome::xml::model::ROI::setID
void setID(const std::string &id)
Set the ID property.
Definition: ROI.cpp:378
ome::xml::model::ROI::linkImage
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: ROI.cpp:536
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::ROI::getNamespace
ome::compat::shared_ptr< std::string > getNamespace()
Get the Namespace property.
Definition: ROI.cpp:350
ome::xml::model::ROI::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ROI.cpp:729
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::ROI::getUnion
ome::compat::shared_ptr< ome::xml::model::Union > getUnion()
Get the Union property.
Definition: ROI.cpp:406
ome::xml::model::ROI::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: ROI.cpp:319
ome::xml::model::ROI::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: ROI.cpp:526
ome::xml::model::ROI::setUnion
void setUnion(ome::compat::shared_ptr< ome::xml::model::Union > &union_)
Set the Union property.
Definition: ROI.cpp:420
ome::xml::model::ROI::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: ROI.cpp:501
ome::xml::model::ROI::Impl
Private implementation details of ROI model object.
Definition: ROI.cpp:93
ome::xml::model::ROI::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: ROI.cpp:631
ome::xml::model::ROI::sizeOfLinkedMicrobeamManipulationList
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:566
ome::xml::model::ROI::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: ROI.cpp:385
ome::xml::model::ROI::setLinkedAnnotation
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:445
ome::xml::model::ROI::unlinkImage
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: ROI.cpp:549
ome::xml::model::ROI::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: ROI.cpp:399
ome::xml::model::ROI::ROI
ROI()
Default constructor.
Definition: ROI.cpp:182
ome::xml::model::ROI::getLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: ROI.cpp:514
ome::xml::model::ROI::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ROI.h:84
ome::xml::model::ROI::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: ROI.cpp:520
ome::xml::model::ROI::asXMLElement
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:624
log.h
ome::xml::model::ROI::sizeOfLinkedImageList
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:508