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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/Experimenter.h> 64 #include <ome/xml/model/ExperimenterGroup.h> 65 #include <ome/xml/model/detail/OMEModelObject.h> 88 std::shared_ptr<Impl>
impl;
119 static std::shared_ptr<Dataset>
149 link (std::shared_ptr<Reference>& reference,
150 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
157 std::shared_ptr<std::string>
165 const std::shared_ptr<std::string>
174 setName (std::shared_ptr<std::string>& name);
190 setID (
const std::string&
id);
197 std::shared_ptr<std::string>
205 const std::shared_ptr<std::string>
222 std::weak_ptr<ome::xml::model::Experimenter>
231 const std::weak_ptr<ome::xml::model::Experimenter>
240 linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);
260 std::weak_ptr<ome::xml::model::ExperimenterGroup>
269 const std::weak_ptr<ome::xml::model::ExperimenterGroup>
315 const std::weak_ptr<ome::xml::model::Image>&
328 const std::weak_ptr<ome::xml::model::Image>&
330 const std::shared_ptr<ome::xml::model::Image>& image);
343 linkImage (
const std::shared_ptr<ome::xml::model::Image>& image);
361 unlinkImage (
const std::shared_ptr<ome::xml::model::Image>& image);
386 const std::weak_ptr<ome::xml::model::Annotation>&
399 const std::weak_ptr<ome::xml::model::Annotation>&
401 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
414 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
432 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
457 const std::weak_ptr<ome::xml::model::Project>&
470 const std::weak_ptr<ome::xml::model::Project>&
472 const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
485 linkProject (
const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
503 unlinkProject (
const std::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:61
Private implementation details of Dataset model object.
Definition: Dataset.cpp:79
bool unlinkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Dataset.cpp:645
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: Dataset.cpp:301
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: Dataset.cpp:562
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dataset.cpp:550
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: Dataset.cpp:502
std::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Dataset.cpp:455
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: Dataset.cpp:604
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Dataset.cpp:419
Dataset & operator=(const Dataset &)
Assignment operator (deleted).
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Dataset.cpp:610
const std::weak_ptr< ome::xml::model::Project > & setLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Set linked Project.
Definition: Dataset.cpp:622
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Dataset.cpp:405
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
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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: Dataset.cpp:661
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Dataset.cpp:484
void unlinkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Dataset.cpp:445
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Dataset.h:86
static std::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:187
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Dataset.cpp:370
void linkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Dataset.cpp:439
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
Dataset()
Default constructor.
Definition: Dataset.cpp:167
Open Microscopy Environment C++ implementation.
bool linkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Dataset.cpp:632
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:209
const std::weak_ptr< ome::xml::model::Project > & getLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index) const
Get linked Project.
Definition: Dataset.cpp:616
const std::string & getID() const
Get the ID property.
Definition: Dataset.cpp:391
void unlinkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Dataset.cpp:474
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Dataset.cpp:490
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dataset.cpp:586
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dataset.cpp:572
virtual ~Dataset()
Destructor.
Definition: Dataset.cpp:182
Dataset model object.
Definition: Dataset.h:83
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Dataset.cpp:526
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: Dataset.cpp:556
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: Dataset.cpp:512
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dataset.cpp:776
std::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Dataset.cpp:426
void linkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Dataset.cpp:468
void setID(const std::string &id)
Set the ID property.
Definition: Dataset.cpp:398
const std::string & elementName() const
Get the element name of this model object.
Definition: Dataset.cpp:196
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Dataset.cpp:384
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dataset.cpp:203
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: Dataset.cpp:496
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Dataset.cpp:544