ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Union.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class Annotation;
76 class Folder;
77 class Image;
78 class MicrobeamManipulation;
79 class OMEModel;
80
84 class ROI : public detail::OMEModelObject
85 {
86 private:
87 class Impl;
89 ome::compat::shared_ptr<Impl> impl;
90
91 public:
93 ROI();
94
100 ROI (const ROI& copy);
101
103 virtual
104 ~ROI ();
105
120 static ome::compat::shared_ptr< ROI>
121 create(const common::xml::dom::Element& element,
122 ome::xml::model::OMEModel& model);
123
124 // Documented in superclass.
125 const std::string&
126 elementName() const;
127
128 // Documented in superclass.
129 bool
130 validElementName(const std::string& name) const;
131
132 private:
134 ROI&
135 operator= (const ROI&);
136
137 public:
138 // -- OMEModelObject API methods --
139
141 virtual void
142 update(const common::xml::dom::Element& element,
143 ome::xml::model::OMEModel& model);
144
145 public:
146 // -- ROI API methods --
147
149 bool
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152
158 const std::string&
159 getID () const;
160
166 void
167 setID (const std::string& id);
168
174 ome::compat::shared_ptr<std::string>
175 getName ();
176
182 const ome::compat::shared_ptr<std::string>
183 getName () const;
184
190 void
191 setName (ome::compat::shared_ptr<std::string>& name);
192
198 ome::compat::shared_ptr<ome::xml::model::Union>
199 getUnion ();
200
206 const ome::compat::shared_ptr<ome::xml::model::Union>
207 getUnion () const;
208
214 void
215 setUnion (ome::compat::shared_ptr<ome::xml::model::Union>& union_);
216
222 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
223 sizeOfLinkedAnnotationList () const;
224
230 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
231 getLinkedAnnotationList () const;
232
240 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
241 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
242
253 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
254 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
255 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
256
267 bool
268 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
269
285 bool
286 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
287
293 ome::compat::shared_ptr<std::string>
294 getDescription ();
295
301 const ome::compat::shared_ptr<std::string>
302 getDescription () const;
303
309 void
310 setDescription (ome::compat::shared_ptr<std::string>& description);
311
317 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type
318 sizeOfLinkedImageList () const;
319
325 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type
326 getLinkedImageList () const;
327
335 const ome::compat::weak_ptr<ome::xml::model::Image>&
336 getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index) const;
337
348 const ome::compat::weak_ptr<ome::xml::model::Image>&
349 setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
350 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
351
362 bool
363 linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
364
380 bool
381 unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
382
388 OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type
389 sizeOfLinkedMicrobeamManipulationList () const;
390
396 OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type
397 getLinkedMicrobeamManipulationList () const;
398
406 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
407 getLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type index) const;
408
419 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
420 setLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type index,
421 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
422
433 bool
434 linkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
435
451 bool
452 unlinkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
453
459 OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type::size_type
460 sizeOfLinkedFolderList () const;
461
467 OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type
468 getLinkedFolderList () const;
469
477 const ome::compat::weak_ptr<ome::xml::model::Folder>&
478 getLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type::size_type index) const;
479
490 const ome::compat::weak_ptr<ome::xml::model::Folder>&
491 setLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type::size_type index,
492 const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
493
504 bool
505 linkFolder (const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
506
522 bool
523 unlinkFolder (const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
524
526 virtual common::xml::dom::Element
527 asXMLElement (common::xml::dom::Document& document) const;
528
529
530 protected:
531 // Documented in base class.
532 virtual common::xml::dom::Element
533 asXMLElementInternal (common::xml::dom::Document& document,
534 common::xml::dom::Element& element) const;
535
536 public:
537 // Documented in superclass.
538 const std::string&
539 getXMLNamespace() const;
540 };
541
542 }
543 }
544 }
545
546 #endif // OME_XML_MODEL_ROI_H
547
548 /*
549 * Local Variables:
550 * mode:C++
551 * End:
552 */
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:193
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:222
ome::xml::model::ROI::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: ROI.cpp:431
ome::xml::model::ROI::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: ROI.cpp:417
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:546
ome::xml::model::ROI::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: ROI.cpp:449
ome::xml::model::ROI
ROI model object.
Definition: ROI.h:84
ome::xml::model::ROI::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ROI.cpp:738
ome::xml::model::ROI::unlinkMicrobeamManipulation
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Unlink MicrobeamManipulation.
Definition: ROI.cpp:569
ome::common::xml::dom::Document
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:198
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::ROI::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: ROI.cpp:395
ome::xml::model::ROI::linkMicrobeamManipulation
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation_BackReference)
Link MicrobeamManipulation.
Definition: ROI.cpp:556
ome::xml::model::ROI::linkFolder
bool linkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: ROI.cpp:614
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:528
ome::xml::model::ROI::setID
void setID(const std::string &id)
Set the ID property.
Definition: ROI.cpp:340
ome::xml::model::ROI::linkImage
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: ROI.cpp:498
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:389
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome
Open Microscopy Environment C++ implementation.
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:643
ome::xml::model::ROI::getUnion
ome::compat::shared_ptr< ome::xml::model::Union > getUnion()
Get the Union property.
Definition: ROI.cpp:368
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:302
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:488
ome::xml::model::ROI::setUnion
void setUnion(ome::compat::shared_ptr< ome::xml::model::Union > &union_)
Set the Union property.
Definition: ROI.cpp:382
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:214
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:534
ome::xml::model::ROI::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: ROI.cpp:463
ome::xml::model::ROI::Impl
Private implementation details of ROI model object.
Definition: ROI.cpp:90
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:470
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:650
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:482
ome::xml::model::ROI::unlinkFolder
bool unlinkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: ROI.cpp:627
ome::xml::model::ROI::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: ROI.cpp:347
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:407
ome::xml::model::ROI::unlinkImage
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: ROI.cpp:511
ome::xml::model::ROI::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: ROI.cpp:361
ome::xml::model::ROI::setLinkedFolder
const ome::compat::weak_ptr< ome::xml::model::Folder > & setLinkedFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Set linked Folder.
Definition: ROI.cpp:604
ome::xml::model::ROI::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: ROI.cpp:207
ome::xml::model::ROI::ROI
ROI()
Default constructor.
Definition: ROI.cpp:178
ome::xml::model::ROI::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ROI.h:87
ome::xml::model::ROI::getID
const std::string & getID() const
Get the ID property.
Definition: ROI.cpp:333
ome::xml::model::ROI::operator=
ROI & operator=(const ROI &)
Assignment operator (deleted).
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:540
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:401
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:476
log.h
ome::xml::model::ROI::getLinkedFolder
const ome::compat::weak_ptr< ome::xml::model::Folder > & getLinkedFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type index) const
Get linked Folder.
Definition: ROI.cpp:598
ome::xml::model::ROI::sizeOfLinkedFolderList
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: ROI.cpp:586
ome::xml::model::ROI::getLinkedFolderList
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: ROI.cpp:592