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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/detail/OMEModelObject.h> 86 std::shared_ptr<Impl>
impl;
117 static std::shared_ptr<Folder>
147 link (std::shared_ptr<Reference>& reference,
148 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
164 setID (
const std::string&
id);
171 std::shared_ptr<std::string>
179 const std::shared_ptr<std::string>
188 setName (std::shared_ptr<std::string>& name);
195 std::shared_ptr<std::string>
203 const std::shared_ptr<std::string>
237 const std::weak_ptr<ome::xml::model::Folder>&
250 const std::weak_ptr<ome::xml::model::Folder>&
252 const std::shared_ptr<ome::xml::model::Folder>& folder);
265 linkFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder);
283 unlinkFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder);
308 const std::weak_ptr<ome::xml::model::Image>&
321 const std::weak_ptr<ome::xml::model::Image>&
323 const std::shared_ptr<ome::xml::model::Image>& image);
336 linkImage (
const std::shared_ptr<ome::xml::model::Image>& image);
354 unlinkImage (
const std::shared_ptr<ome::xml::model::Image>& image);
379 const std::weak_ptr<ome::xml::model::ROI>&
392 const std::weak_ptr<ome::xml::model::ROI>&
394 const std::shared_ptr<ome::xml::model::ROI>& roi);
407 linkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
425 unlinkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
450 const std::weak_ptr<ome::xml::model::Annotation>&
463 const std::weak_ptr<ome::xml::model::Annotation>&
465 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
478 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
496 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
521 const std::weak_ptr<ome::xml::model::Folder>&
534 const std::weak_ptr<ome::xml::model::Folder>&
536 const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
549 linkChildFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
567 unlinkChildFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
585 #endif // OME_XML_MODEL_FOLDER_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Folder.cpp:617
const std::weak_ptr< ome::xml::model::Folder > & getLinkedFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index) const
Get linked Folder.
Definition: Folder.cpp:445
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Folder.cpp:551
bool unlinkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder)
Unlink Folder.
Definition: Folder.cpp:474
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Folder.cpp:639
virtual ~Folder()
Destructor.
Definition: Folder.cpp:180
const std::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Image > &image)
Set linked Image.
Definition: Folder.cpp:509
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Folder.cpp:851
bool linkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder)
Link Folder.
Definition: Folder.cpp:461
const std::string & getID() const
Get the ID property.
Definition: Folder.cpp:377
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Folder.cpp:497
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Folder.cpp:653
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: Folder.cpp:433
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Folder.cpp:491
const std::weak_ptr< ome::xml::model::Folder > & setLinkedChildFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Set linked ChildFolder.
Definition: Folder.cpp:689
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 > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
const std::weak_ptr< ome::xml::model::Folder > & getLinkedChildFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index) const
Get linked ChildFolder.
Definition: Folder.cpp:683
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Folder.cpp:629
Folder model object.
Definition: Folder.h:81
const std::weak_ptr< ome::xml::model::ROI > & getLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index) const
Get linked ROI.
Definition: Folder.cpp:563
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Folder.h:84
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Folder.cpp:623
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type sizeOfLinkedChildFolderList() const
Get size of linked ChildFolder list.
Definition: Folder.cpp:671
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: Folder.cpp:519
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:207
Private implementation details of Folder model object.
Definition: Folder.cpp:77
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Folder.cpp:299
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Folder.cpp:405
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
static std::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:185
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Folder.cpp:611
void setID(const std::string &id)
Set the ID property.
Definition: Folder.cpp:384
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Folder.cpp:412
Open Microscopy Environment C++ implementation.
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Folder.cpp:426
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Folder.cpp:439
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type getLinkedChildFolderList() const
Get the linked ChildFolder list.
Definition: Folder.cpp:677
bool unlinkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Folder.cpp:593
bool linkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Folder.cpp:579
const std::weak_ptr< ome::xml::model::ROI > & setLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ROI > &roi)
Set linked ROI.
Definition: Folder.cpp:569
const std::string & elementName() const
Get the element name of this model object.
Definition: Folder.cpp:194
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Folder.cpp:533
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Folder.cpp:391
bool unlinkChildFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink ChildFolder.
Definition: Folder.cpp:712
const std::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: Folder.cpp:503
bool linkChildFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link ChildFolder.
Definition: Folder.cpp:699
Folder()
Default constructor.
Definition: Folder.cpp:165
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Folder.cpp:557
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Folder.cpp:201
const std::weak_ptr< ome::xml::model::Folder > & setLinkedFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Folder > &folder)
Set linked Folder.
Definition: Folder.cpp:451
Folder & operator=(const Folder &)
Assignment operator (deleted).
virtual void 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:728