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>
61 #include <ome/xml/model/primitives/Quantity.h>
63 #include <ome/xml/model/Experiment.h>
64 #include <ome/xml/model/Experimenter.h>
65 #include <ome/xml/model/ExperimenterGroup.h>
66 #include <ome/xml/model/ImagingEnvironment.h>
67 #include <ome/xml/model/Instrument.h>
68 #include <ome/xml/model/ObjectiveSettings.h>
69 #include <ome/xml/model/Pixels.h>
70 #include <ome/xml/model/StageLabel.h>
71 #include <ome/xml/model/detail/OMEModelObject.h>
72 #include <ome/xml/model/primitives/Timestamp.h>
85 class MicrobeamManipulation;
98 std::shared_ptr<Impl>
impl;
129 static std::shared_ptr<Image>
143 operator= (
const Image&) =
delete;
158 link (std::shared_ptr<Reference>& reference,
159 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
175 setID (
const std::string&
id);
182 std::shared_ptr<std::string>
190 const std::shared_ptr<std::string>
199 setName (std::shared_ptr<std::string>& name);
206 std::shared_ptr<ome::xml::model::primitives::Timestamp>
214 const std::shared_ptr<ome::xml::model::primitives::Timestamp>
223 setAcquisitionDate (std::shared_ptr<ome::xml::model::primitives::Timestamp>& acquisitionDate);
231 std::weak_ptr<ome::xml::model::Experimenter>
240 const std::weak_ptr<ome::xml::model::Experimenter>
249 linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);
268 std::shared_ptr<std::string>
276 const std::shared_ptr<std::string>
293 std::weak_ptr<ome::xml::model::Experiment>
302 const std::weak_ptr<ome::xml::model::Experiment>
311 linkExperiment (std::shared_ptr<ome::xml::model::Experiment>& experiment);
323 unlinkExperiment (std::shared_ptr<ome::xml::model::Experiment>& experiment);
331 std::weak_ptr<ome::xml::model::ExperimenterGroup>
340 const std::weak_ptr<ome::xml::model::ExperimenterGroup>
369 std::weak_ptr<ome::xml::model::Instrument>
378 const std::weak_ptr<ome::xml::model::Instrument>
387 linkInstrument (std::shared_ptr<ome::xml::model::Instrument>& instrument);
399 unlinkInstrument (std::shared_ptr<ome::xml::model::Instrument>& instrument);
406 std::shared_ptr<ome::xml::model::ObjectiveSettings>
414 const std::shared_ptr<ome::xml::model::ObjectiveSettings>
430 std::shared_ptr<ome::xml::model::ImagingEnvironment>
438 const std::shared_ptr<ome::xml::model::ImagingEnvironment>
454 std::shared_ptr<ome::xml::model::StageLabel>
462 const std::shared_ptr<ome::xml::model::StageLabel>
471 setStageLabel (std::shared_ptr<ome::xml::model::StageLabel>& stageLabel);
478 std::shared_ptr<ome::xml::model::Pixels>
486 const std::shared_ptr<ome::xml::model::Pixels>
495 setPixels (std::shared_ptr<ome::xml::model::Pixels>& pixels);
520 const std::weak_ptr<ome::xml::model::ROI>&
533 const std::weak_ptr<ome::xml::model::ROI>&
535 const std::shared_ptr<ome::xml::model::ROI>& roi);
548 linkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
566 unlinkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
591 const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
604 const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
606 const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
662 const std::weak_ptr<ome::xml::model::Annotation>&
675 const std::weak_ptr<ome::xml::model::Annotation>&
677 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
690 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
708 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
733 const std::weak_ptr<ome::xml::model::Dataset>&
746 const std::weak_ptr<ome::xml::model::Dataset>&
748 const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
761 linkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
779 unlinkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
804 const std::weak_ptr<ome::xml::model::Folder>&
817 const std::weak_ptr<ome::xml::model::Folder>&
819 const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
832 linkFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
850 unlinkFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
875 const std::weak_ptr<ome::xml::model::WellSample>&
888 const std::weak_ptr<ome::xml::model::WellSample>&
890 const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
903 linkWellSample (
const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
921 unlinkWellSample (
const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
939 #endif // OME_XML_MODEL_IMAGE_H
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Image.cpp:1216
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Image.cpp:722
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: Image.cpp:1164
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Image.cpp:665
std::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Image.cpp:772
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Image.h:96
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Image.cpp:1094
bool unlinkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: Image.cpp:1193
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: Image.cpp:530
static std::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:307
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: Image.cpp:1046
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
bool unlinkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Image.cpp:1135
void setStageLabel(std::shared_ptr< ome::xml::model::StageLabel > &stageLabel)
Set the StageLabel property.
Definition: Image.cpp:886
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: Image.cpp:1052
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type sizeOfLinkedMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Image.cpp:974
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
Image model object.
Definition: Image.h:93
bool linkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Image.cpp:1122
void setObjectiveSettings(std::shared_ptr< ome::xml::model::ObjectiveSettings > &objectiveSettings)
Set the ObjectiveSettings property.
Definition: Image.cpp:844
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Image.cpp:914
const std::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Set linked WellSample.
Definition: Image.cpp:1228
OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type sizeOfLinkedWellSampleList() const
Get size of linked WellSample list.
Definition: Image.cpp:1210
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Image.cpp:1158
Private implementation details of Image model object.
Definition: Image.cpp:125
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Image.cpp:1076
void setImagingEnvironment(std::shared_ptr< ome::xml::model::ImagingEnvironment > &imagingEnvironment)
Set the ImagingEnvironment property.
Definition: Image.cpp:865
const std::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Set linked Dataset.
Definition: Image.cpp:1112
const std::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type index) const
Get linked WellSample.
Definition: Image.cpp:1222
bool unlinkWellSample(const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Image.cpp:1251
bool unlinkMicrobeamManipulation(const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Unlink MicrobeamManipulation.
Definition: Image.cpp:1016
void setID(const std::string &id)
Set the ID property.
Definition: Image.cpp:644
bool linkWellSample(const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Image.cpp:1238
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Image.cpp:920
std::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Image.cpp:693
virtual SKIP 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:329
void setPixels(std::shared_ptr< ome::xml::model::Pixels > &pixels)
Set the Pixels property.
Definition: Image.cpp:907
Image()
Default constructor.
Definition: Image.cpp:287
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
bool linkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: Image.cpp:1180
const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & getLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type index) const
Get linked MicrobeamManipulation.
Definition: Image.cpp:986
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Image.cpp:736
const std::string & getID() const
Get the ID property.
Definition: Image.cpp:637
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Image.cpp:1040
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: Image.cpp:932
const std::weak_ptr< ome::xml::model::MicrobeamManipulation > & setLinkedMicrobeamManipulation(OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Set linked MicrobeamManipulation.
Definition: Image.cpp:992
void linkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Image.cpp:706
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: Image.cpp:1152
std::shared_ptr< ome::xml::model::ObjectiveSettings > getObjectiveSettings()
Get the ObjectiveSettings property.
Definition: Image.cpp:830
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: Image.cpp:980
void linkInstrument(std::shared_ptr< ome::xml::model::Instrument > &instrument)
Link Instrument.
Definition: Image.cpp:814
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: Image.cpp:926
void unlinkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Image.cpp:791
std::weak_ptr< ome::xml::model::Experiment > getLinkedExperiment()
Get linked Experiment.
Definition: Image.cpp:743
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Image.cpp:323
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Image.cpp:1034
virtual ~Image()
Destructor.
Definition: Image.cpp:302
std::weak_ptr< ome::xml::model::Instrument > getLinkedInstrument()
Get linked Instrument.
Definition: Image.cpp:801
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Image.cpp:1062
bool unlinkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Image.cpp:956
void setAcquisitionDate(std::shared_ptr< ome::xml::model::primitives::Timestamp > &acquisitionDate)
Set the AcquisitionDate property.
Definition: Image.cpp:686
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Image.cpp:1100
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: Image.cpp:1267
std::shared_ptr< ome::xml::model::primitives::Timestamp > getAcquisitionDate()
Get the AcquisitionDate property.
Definition: Image.cpp:672
void linkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Image.cpp:785
void linkExperiment(std::shared_ptr< ome::xml::model::Experiment > &experiment)
Link Experiment.
Definition: Image.cpp:756
std::shared_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Image.cpp:893
const std::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index) const
Get linked Dataset.
Definition: Image.cpp:1106
void unlinkInstrument(std::shared_ptr< ome::xml::model::Instrument > &instrument)
Unlink Instrument.
Definition: Image.cpp:820
bool linkMicrobeamManipulation(const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Link MicrobeamManipulation.
Definition: Image.cpp:1002
bool linkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Image.cpp:942
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Image.cpp:1476
std::shared_ptr< ome::xml::model::StageLabel > getStageLabel()
Get the StageLabel property.
Definition: Image.cpp:872
void unlinkExperiment(std::shared_ptr< ome::xml::model::Experiment > &experiment)
Unlink Experiment.
Definition: Image.cpp:762
const std::string & elementName() const
Get the element name of this model object.
Definition: Image.cpp:316
std::shared_ptr< ome::xml::model::ImagingEnvironment > getImagingEnvironment()
Get the ImagingEnvironment property.
Definition: Image.cpp:851
void unlinkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Image.cpp:712
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Image.cpp:651
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_BackReference)
Set linked Folder.
Definition: Image.cpp:1170