46 #ifndef OME_XML_MODEL_ROI_H 47 #define OME_XML_MODEL_ROI_H 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> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Union.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 78 class MicrobeamManipulation;
89 ome::compat::shared_ptr<Impl>
impl;
120 static ome::compat::shared_ptr< ROI>
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
167 setID (
const std::string&
id);
174 ome::compat::shared_ptr<std::string>
182 const ome::compat::shared_ptr<std::string>
191 setName (ome::compat::shared_ptr<std::string>& name);
198 ome::compat::shared_ptr<ome::xml::model::Union>
206 const ome::compat::shared_ptr<ome::xml::model::Union>
215 setUnion (ome::compat::shared_ptr<ome::xml::model::Union>& union_);
240 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
253 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
255 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
268 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
286 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
293 ome::compat::shared_ptr<std::string>
301 const ome::compat::shared_ptr<std::string>
310 setDescription (ome::compat::shared_ptr<std::string>& description);
335 const ome::compat::weak_ptr<ome::xml::model::Image>&
348 const ome::compat::weak_ptr<ome::xml::model::Image>&
350 const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
363 linkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
381 unlinkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
406 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
419 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
421 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
434 linkMicrobeamManipulation (
const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
452 unlinkMicrobeamManipulation (
const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation_BackReference);
477 const ome::compat::weak_ptr<ome::xml::model::Folder>&
490 const ome::compat::weak_ptr<ome::xml::model::Folder>&
492 const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
505 linkFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
523 unlinkFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
546 #endif // OME_XML_MODEL_ROI_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual ~ROI()
Destructor.
Definition: ROI.cpp:193
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
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: ROI.cpp:431
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: ROI.cpp:417
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 > µbeamManipulation_BackReference)
Set linked MicrobeamManipulation.
Definition: ROI.cpp:546
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: ROI.cpp:449
ROI model object.
Definition: ROI.h:84
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ROI.cpp:738
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation_BackReference)
Unlink MicrobeamManipulation.
Definition: ROI.cpp:569
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 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
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: ROI.cpp:395
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation_BackReference)
Link MicrobeamManipulation.
Definition: ROI.cpp:556
bool linkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: ROI.cpp:614
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
void setID(const std::string &id)
Set the ID property.
Definition: ROI.cpp:340
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: ROI.cpp:498
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
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
Open Microscopy Environment C++ implementation.
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::compat::shared_ptr< ome::xml::model::Union > getUnion()
Get the Union property.
Definition: ROI.cpp:368
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
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
void setUnion(ome::compat::shared_ptr< ome::xml::model::Union > &union_)
Set the Union property.
Definition: ROI.cpp:382
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
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: ROI.cpp:534
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: ROI.cpp:463
Private implementation details of ROI model object.
Definition: ROI.cpp:90
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
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
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
bool unlinkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: ROI.cpp:627
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: ROI.cpp:347
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
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: ROI.cpp:511
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: ROI.cpp:361
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
const std::string & elementName() const
Get the element name of this model object.
Definition: ROI.cpp:207
ROI()
Default constructor.
Definition: ROI.cpp:178
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: ROI.h:87
const std::string & getID() const
Get the ID property.
Definition: ROI.cpp:333
ROI & operator=(const ROI &)
Assignment operator (deleted).
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
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
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: ROI.cpp:476
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
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
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: ROI.cpp:592