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/primitives/Quantity.h> 64 #include <ome/xml/model/Experimenter.h> 65 #include <ome/xml/model/ExperimenterGroup.h> 66 #include <ome/xml/model/detail/OMEModelObject.h> 89 ome::compat::shared_ptr<Impl>
impl;
120 static ome::compat::shared_ptr< Dataset>
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
158 ome::compat::shared_ptr<std::string>
166 const ome::compat::shared_ptr<std::string>
175 setName (ome::compat::shared_ptr<std::string>& name);
191 setID (
const std::string&
id);
198 ome::compat::shared_ptr<std::string>
206 const ome::compat::shared_ptr<std::string>
215 setDescription (ome::compat::shared_ptr<std::string>& description);
223 ome::compat::weak_ptr<ome::xml::model::Experimenter>
232 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
241 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
253 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
261 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
270 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
279 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
316 const ome::compat::weak_ptr<ome::xml::model::Image>&
329 const ome::compat::weak_ptr<ome::xml::model::Image>&
331 const ome::compat::shared_ptr<ome::xml::model::Image>& image);
344 linkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image);
362 unlinkImage (
const ome::compat::shared_ptr<ome::xml::model::Image>& image);
387 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
400 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
402 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
415 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
433 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
458 const ome::compat::weak_ptr<ome::xml::model::Project>&
471 const ome::compat::weak_ptr<ome::xml::model::Project>&
473 const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
486 linkProject (
const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
504 unlinkProject (
const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
527 #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:522
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:478
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Dataset.cpp:536
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dataset.cpp:596
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Dataset.cpp:380
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:632
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:566
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:572
Dataset & operator=(const Dataset &)
Assignment operator (deleted).
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Dataset.cpp:455
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dataset.cpp:582
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Dataset.cpp:394
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Dataset.cpp:642
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:614
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
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:506
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
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Dataset.cpp:449
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:626
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Dataset.h:87
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:678
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Dataset.cpp:415
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Dataset.cpp:484
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
Dataset()
Default constructor.
Definition: Dataset.cpp:167
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:512
Open Microscopy Environment C++ implementation.
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:211
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Dataset.cpp:436
const std::string & getID() const
Get the ID property.
Definition: Dataset.cpp:401
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:671
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:554
virtual ~Dataset()
Destructor.
Definition: Dataset.cpp:182
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Dataset.cpp:655
Dataset model object.
Definition: Dataset.h:84
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Dataset.cpp:429
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dataset.cpp:560
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dataset.cpp:807
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:311
void setID(const std::string &id)
Set the ID property.
Definition: Dataset.cpp:408
const std::string & elementName() const
Get the element name of this model object.
Definition: Dataset.cpp:196
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:187
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Dataset.cpp:620
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
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Dataset.cpp:500
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Dataset.cpp:465
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:494