46 #ifndef OME_XML_MODEL_DATASET_H
47 #define OME_XML_MODEL_DATASET_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/Experimenter.h>
63 #include <ome/xml/model/ExperimenterGroup.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
87 ome::compat::shared_ptr<Impl>
impl;
118 static ome::compat::shared_ptr< Dataset>
143 link (ome::compat::shared_ptr<Reference>& reference,
144 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
151 ome::compat::shared_ptr<std::string>
159 const ome::compat::shared_ptr<std::string>
168 setName (ome::compat::shared_ptr<std::string>& name);
184 setID (
const std::string&
id);
191 ome::compat::shared_ptr<std::string>
199 const ome::compat::shared_ptr<std::string>
208 setDescription (ome::compat::shared_ptr<std::string>& description);
216 ome::compat::weak_ptr<ome::xml::model::Experimenter>
225 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
234 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
246 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
254 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
263 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
272 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
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::Annotation>&
393 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
395 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
408 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
426 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
451 const ome::compat::weak_ptr<ome::xml::model::Project>&
464 const ome::compat::weak_ptr<ome::xml::model::Project>&
466 const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
479 linkProject (
const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
497 unlinkProject (
const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
521 #endif // OME_XML_MODEL_DATASET_H
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: Dataset.cpp:527
Private implementation details of Dataset model object.
Definition: Dataset.cpp:79
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Dataset.cpp:483
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Dataset.cpp:541
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dataset.cpp:601
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Dataset.cpp:385
const std::string & elementName() const
Get the element name of this model object.
Definition: Dataset.cpp:201
const ome::compat::weak_ptr< ome::xml::model::Project > & setLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Set linked Project.
Definition: Dataset.cpp:637
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: Dataset.cpp:577
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Dataset.cpp:460
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Dataset.cpp:625
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dataset.cpp:587
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dataset.cpp:813
DOM Document wrapper.
Definition: Document.h:83
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: Dataset.cpp:511
DOM Element wrapper.
Definition: Element.h:66
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Dataset.cpp:399
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Dataset.cpp:647
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Dataset.cpp:559
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
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Dataset.cpp:677
const ome::compat::weak_ptr< ome::xml::model::Project > & getLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index) const
Get linked Project.
Definition: Dataset.cpp:631
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: Dataset.cpp:571
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Dataset.cpp:454
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Dataset.h:85
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Dataset.cpp:420
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Dataset.cpp:489
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Dataset.cpp:505
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: Dataset.cpp:619
Dataset()
Default constructor.
Definition: Dataset.cpp:168
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: Dataset.cpp:517
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
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: Dataset.cpp:217
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Dataset.cpp:441
const std::string & getID() const
Get the ID property.
Definition: Dataset.cpp:406
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: Dataset.cpp:684
virtual ~Dataset()
Destructor.
Definition: Dataset.cpp:187
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Dataset.cpp:660
Dataset model object.
Definition: Dataset.h:82
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Dataset.cpp:434
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: Dataset.cpp:316
void setID(const std::string &id)
Set the ID property.
Definition: Dataset.cpp:413
static ome::compat::shared_ptr< Dataset > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Dataset model object from DOM element.
Definition: Dataset.cpp:192
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dataset.cpp:208
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Dataset.cpp:499
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dataset.cpp:565
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Dataset.cpp:470
Xerces-C modern C++ wrapper.
Definition: Base.h:53