46 #ifndef OME_XML_MODEL_FOLDER_H 47 #define OME_XML_MODEL_FOLDER_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/detail/OMEModelObject.h> 87 ome::compat::shared_ptr<Impl>
impl;
118 static ome::compat::shared_ptr< Folder>
148 link (ome::compat::shared_ptr<Reference>& reference,
149 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
165 setID (
const std::string&
id);
172 ome::compat::shared_ptr<std::string>
180 const ome::compat::shared_ptr<std::string>
189 setName (ome::compat::shared_ptr<std::string>& name);
196 ome::compat::shared_ptr<std::string>
204 const ome::compat::shared_ptr<std::string>
213 setDescription (ome::compat::shared_ptr<std::string>& description);
238 const ome::compat::weak_ptr<ome::xml::model::Folder>&
251 const ome::compat::weak_ptr<ome::xml::model::Folder>&
253 const ome::compat::shared_ptr<ome::xml::model::Folder>& folder);
266 linkFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder);
284 unlinkFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder);
309 const ome::compat::weak_ptr<ome::xml::model::Image>&
322 const ome::compat::weak_ptr<ome::xml::model::Image>&
324 const ome::compat::shared_ptr<ome::xml::model::Image>& image);
337 linkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image);
355 unlinkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image);
380 const ome::compat::weak_ptr<ome::xml::model::ROI>&
393 const ome::compat::weak_ptr<ome::xml::model::ROI>&
395 const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
408 linkROI (
const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
426 unlinkROI (
const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
451 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
464 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
466 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
479 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
497 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
522 const ome::compat::weak_ptr<ome::xml::model::Folder>&
535 const ome::compat::weak_ptr<ome::xml::model::Folder>&
537 const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
550 linkChildFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
568 unlinkChildFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
591 #endif // OME_XML_MODEL_FOLDER_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool unlinkChildFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink ChildFolder.
Definition: Folder.cpp:726
virtual ~Folder()
Destructor.
Definition: Folder.cpp:184
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Folder.h:85
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: Folder.cpp:533
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Folder.cpp:405
const ome::compat::weak_ptr< ome::xml::model::ROI > & setLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Set linked ROI.
Definition: Folder.cpp:583
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: Folder.cpp:637
bool linkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder)
Link Folder.
Definition: Folder.cpp:475
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Folder.cpp:565
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Folder.cpp:419
const ome::compat::weak_ptr< ome::xml::model::Folder > & setLinkedChildFolder(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 ChildFolder.
Definition: Folder.cpp:703
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: Folder.cpp:313
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Folder.cpp:625
bool linkChildFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link ChildFolder.
Definition: Folder.cpp:713
static ome::compat::shared_ptr< Folder > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Folder model object from DOM element.
Definition: Folder.cpp:189
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: Folder.cpp:749
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::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Folder.cpp:511
Folder model object.
Definition: Folder.h:82
bool unlinkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder)
Unlink Folder.
Definition: Folder.cpp:488
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type getLinkedChildFolderList() const
Get the linked ChildFolder list.
Definition: Folder.cpp:691
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Folder.cpp:571
const std::string & getID() const
Get the ID property.
Definition: Folder.cpp:391
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: Folder.cpp:517
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Folder.cpp:631
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type sizeOfLinkedChildFolderList() const
Get size of linked ChildFolder list.
Definition: Folder.cpp:685
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Folder.cpp:593
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: Folder.cpp:213
Private implementation details of Folder model object.
Definition: Folder.cpp:77
const std::string & elementName() const
Get the element name of this model object.
Definition: Folder.cpp:198
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Folder.cpp:890
void setID(const std::string &id)
Set the ID property.
Definition: Folder.cpp:398
Open Microscopy Environment C++ implementation.
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Folder.cpp:667
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)
Set linked Image.
Definition: Folder.cpp:523
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Folder.cpp:653
const ome::compat::weak_ptr< ome::xml::model::ROI > & getLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index) const
Get linked ROI.
Definition: Folder.cpp:577
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Folder.cpp:742
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)
Set linked Folder.
Definition: Folder.cpp:465
const ome::compat::weak_ptr< ome::xml::model::Folder > & getLinkedChildFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type index) const
Get linked ChildFolder.
Definition: Folder.cpp:697
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: Folder.cpp:643
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Folder.cpp:440
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: Folder.cpp:447
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Folder.cpp:426
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Folder.cpp:607
Folder()
Default constructor.
Definition: Folder.cpp:165
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Folder.cpp:453
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Folder.cpp:547
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Folder.cpp:505
Folder & operator=(const Folder &)
Assignment operator (deleted).
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: Folder.cpp:459
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Folder.cpp:205