46 #ifndef OME_XML_MODEL_IMAGE_H 47 #define OME_XML_MODEL_IMAGE_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/Experiment.h> 65 #include <ome/xml/model/Experimenter.h> 66 #include <ome/xml/model/ExperimenterGroup.h> 67 #include <ome/xml/model/ImagingEnvironment.h> 68 #include <ome/xml/model/Instrument.h> 69 #include <ome/xml/model/ObjectiveSettings.h> 70 #include <ome/xml/model/Pixels.h> 71 #include <ome/xml/model/StageLabel.h> 72 #include <ome/xml/model/detail/OMEModelObject.h> 73 #include <ome/xml/model/primitives/Timestamp.h> 86 class MicrobeamManipulation;
99 ome::compat::shared_ptr<Impl>
impl;
130 static ome::compat::shared_ptr< Image>
160 link (ome::compat::shared_ptr<Reference>& reference,
161 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
177 setID (
const std::string&
id);
184 ome::compat::shared_ptr<std::string>
192 const ome::compat::shared_ptr<std::string>
201 setName (ome::compat::shared_ptr<std::string>& name);
208 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
216 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
225 setAcquisitionDate (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& acquisitionDate);
233 ome::compat::weak_ptr<ome::xml::model::Experimenter>
242 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
251 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
263 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
270 ome::compat::shared_ptr<std::string>
278 const ome::compat::shared_ptr<std::string>
287 setDescription (ome::compat::shared_ptr<std::string>& description);
295 ome::compat::weak_ptr<ome::xml::model::Experiment>
304 const ome::compat::weak_ptr<ome::xml::model::Experiment>
313 linkExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
325 unlinkExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
333 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
342 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
351 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
371 ome::compat::weak_ptr<ome::xml::model::Instrument>
380 const ome::compat::weak_ptr<ome::xml::model::Instrument>
389 linkInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
401 unlinkInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
408 ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>
416 const ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>
425 setObjectiveSettings (ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>& objectiveSettings);
432 ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>
440 const ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>
449 setImagingEnvironment (ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>& imagingEnvironment);
456 ome::compat::shared_ptr<ome::xml::model::StageLabel>
464 const ome::compat::shared_ptr<ome::xml::model::StageLabel>
473 setStageLabel (ome::compat::shared_ptr<ome::xml::model::StageLabel>& stageLabel);
480 ome::compat::shared_ptr<ome::xml::model::Pixels>
488 const ome::compat::shared_ptr<ome::xml::model::Pixels>
497 setPixels (ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels);
522 const ome::compat::weak_ptr<ome::xml::model::ROI>&
535 const ome::compat::weak_ptr<ome::xml::model::ROI>&
537 const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
550 linkROI (
const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
568 unlinkROI (
const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
593 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
606 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
608 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
621 linkMicrobeamManipulation (
const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
664 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
677 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
679 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
692 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
710 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
735 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
748 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
750 const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
763 linkDataset (
const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
781 unlinkDataset (
const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
806 const ome::compat::weak_ptr<ome::xml::model::Folder>&
819 const ome::compat::weak_ptr<ome::xml::model::Folder>&
821 const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
834 linkFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
852 unlinkFolder (
const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
877 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
890 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
892 const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
905 linkWellSample (
const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
923 unlinkWellSample (
const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
946 #endif // OME_XML_MODEL_IMAGE_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > & getLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type index) const
Get linked MicrobeamManipulation.
Definition: Image.cpp:998
const ome::compat::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Set linked WellSample.
Definition: Image.cpp:1240
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: Image.cpp:1286
void setStageLabel(ome::compat::shared_ptr< ome::xml::model::StageLabel > &stageLabel)
Set the StageLabel property.
Definition: Image.cpp:898
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Image.cpp:926
ome::compat::shared_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Image.cpp:905
Image & operator=(const Image &)
Assignment operator (deleted).
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getAcquisitionDate()
Get the AcquisitionDate property.
Definition: Image.cpp:684
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Image.cpp:1074
void unlinkExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Unlink Experiment.
Definition: Image.cpp:774
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Image.cpp:705
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Image.cpp:1524
bool unlinkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: Image.cpp:1205
void setImagingEnvironment(ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > &imagingEnvironment)
Set the ImagingEnvironment property.
Definition: Image.cpp:877
void linkInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Link Instrument.
Definition: Image.cpp:826
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Image.cpp:1250
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Image.cpp:968
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Image.cpp:663
const ome::compat::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Set linked Dataset.
Definition: Image.cpp:1124
void linkExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Link Experiment.
Definition: Image.cpp:768
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Image.cpp:724
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Image.cpp:734
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Image.cpp:986
Image model object.
Definition: Image.h:94
ome::compat::shared_ptr< ome::xml::model::StageLabel > getStageLabel()
Get the StageLabel property.
Definition: Image.cpp:884
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 unlinkInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Unlink Instrument.
Definition: Image.cpp:832
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Image.cpp:1134
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: Image.cpp:938
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Image.cpp:932
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: Image.cpp:1176
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Image.cpp:1052
Private implementation details of Image model object.
Definition: Image.cpp:125
void setID(const std::string &id)
Set the ID property.
Definition: Image.cpp:656
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Link MicrobeamManipulation.
Definition: Image.cpp:1014
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: Image.cpp:327
Image()
Default constructor.
Definition: Image.cpp:283
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Image.cpp:677
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Image.cpp:319
Open Microscopy Environment C++ implementation.
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Image.cpp:803
void setAcquisitionDate(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &acquisitionDate)
Set the AcquisitionDate property.
Definition: Image.cpp:698
ome::compat::weak_ptr< ome::xml::model::Instrument > getLinkedInstrument()
Get linked Instrument.
Definition: Image.cpp:813
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: Image.cpp:1064
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Image.cpp:1046
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Image.cpp:954
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Image.cpp:1263
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Image.cpp:784
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Image.cpp:1147
void setPixels(ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels)
Set the Pixels property.
Definition: Image.cpp:919
const std::string & elementName() const
Get the element name of this model object.
Definition: Image.cpp:312
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Image.cpp:797
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: Image.cpp:992
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Image.cpp:1106
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Image.cpp:1170
ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > getObjectiveSettings()
Get the ObjectiveSettings property.
Definition: Image.cpp:842
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: Image.cpp:944
virtual ~Image()
Destructor.
Definition: Image.cpp:298
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Unlink MicrobeamManipulation.
Definition: Image.cpp:1028
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellSampleList() const
Get size of linked WellSample list.
Definition: Image.cpp:1222
const std::string & getID() const
Get the ID property.
Definition: Image.cpp:649
const ome::compat::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index) const
Get linked Dataset.
Definition: Image.cpp:1118
const ome::compat::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index) const
Get linked WellSample.
Definition: Image.cpp:1234
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Image.cpp:718
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Image.cpp:1112
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: Image.cpp:1164
bool linkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: Image.cpp:1192
ome::compat::weak_ptr< ome::xml::model::Experiment > getLinkedExperiment()
Get linked Experiment.
Definition: Image.cpp:755
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Image.h:97
static ome::compat::shared_ptr< Image > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Image model object from DOM element.
Definition: Image.cpp:303
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Image.cpp:748
const ome::compat::weak_ptr< ome::xml::model::MicrobeamManipulation > & setLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Set linked MicrobeamManipulation.
Definition: Image.cpp:1004
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: Image.cpp:542
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Image.cpp:1279
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: Image.cpp:1058
ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > getImagingEnvironment()
Get the ImagingEnvironment property.
Definition: Image.cpp:863
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Image.cpp:1088
void setObjectiveSettings(ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > &objectiveSettings)
Set the ObjectiveSettings property.
Definition: Image.cpp:856
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Image.cpp:1228
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_BackReference)
Set linked Folder.
Definition: Image.cpp:1182