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>
159 link (std::shared_ptr<Reference>& reference,
160 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
176 setID (
const std::string&
id);
183 std::shared_ptr<std::string>
191 const std::shared_ptr<std::string>
200 setName (std::shared_ptr<std::string>& name);
207 std::shared_ptr<ome::xml::model::primitives::Timestamp>
215 const std::shared_ptr<ome::xml::model::primitives::Timestamp>
224 setAcquisitionDate (std::shared_ptr<ome::xml::model::primitives::Timestamp>& acquisitionDate);
232 std::weak_ptr<ome::xml::model::Experimenter>
241 const std::weak_ptr<ome::xml::model::Experimenter>
250 linkExperimenter (std::shared_ptr<ome::xml::model::Experimenter>& experimenter);
269 std::shared_ptr<std::string>
277 const std::shared_ptr<std::string>
294 std::weak_ptr<ome::xml::model::Experiment>
303 const std::weak_ptr<ome::xml::model::Experiment>
312 linkExperiment (std::shared_ptr<ome::xml::model::Experiment>& experiment);
324 unlinkExperiment (std::shared_ptr<ome::xml::model::Experiment>& experiment);
332 std::weak_ptr<ome::xml::model::ExperimenterGroup>
341 const std::weak_ptr<ome::xml::model::ExperimenterGroup>
370 std::weak_ptr<ome::xml::model::Instrument>
379 const std::weak_ptr<ome::xml::model::Instrument>
388 linkInstrument (std::shared_ptr<ome::xml::model::Instrument>& instrument);
400 unlinkInstrument (std::shared_ptr<ome::xml::model::Instrument>& instrument);
407 std::shared_ptr<ome::xml::model::ObjectiveSettings>
415 const std::shared_ptr<ome::xml::model::ObjectiveSettings>
431 std::shared_ptr<ome::xml::model::ImagingEnvironment>
439 const std::shared_ptr<ome::xml::model::ImagingEnvironment>
455 std::shared_ptr<ome::xml::model::StageLabel>
463 const std::shared_ptr<ome::xml::model::StageLabel>
472 setStageLabel (std::shared_ptr<ome::xml::model::StageLabel>& stageLabel);
479 std::shared_ptr<ome::xml::model::Pixels>
487 const std::shared_ptr<ome::xml::model::Pixels>
496 setPixels (std::shared_ptr<ome::xml::model::Pixels>& pixels);
521 const std::weak_ptr<ome::xml::model::ROI>&
534 const std::weak_ptr<ome::xml::model::ROI>&
536 const std::shared_ptr<ome::xml::model::ROI>& roi);
549 linkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
567 unlinkROI (
const std::shared_ptr<ome::xml::model::ROI>& roi);
592 const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
605 const std::weak_ptr<ome::xml::model::MicrobeamManipulation>&
607 const std::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
663 const std::weak_ptr<ome::xml::model::Annotation>&
676 const std::weak_ptr<ome::xml::model::Annotation>&
678 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
691 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
709 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
734 const std::weak_ptr<ome::xml::model::Dataset>&
747 const std::weak_ptr<ome::xml::model::Dataset>&
749 const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
762 linkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
780 unlinkDataset (
const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
805 const std::weak_ptr<ome::xml::model::Folder>&
818 const std::weak_ptr<ome::xml::model::Folder>&
820 const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
833 linkFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
851 unlinkFolder (
const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
876 const std::weak_ptr<ome::xml::model::WellSample>&
889 const std::weak_ptr<ome::xml::model::WellSample>&
891 const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
904 linkWellSample (
const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
922 unlinkWellSample (
const std::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
940 #endif // OME_XML_MODEL_IMAGE_H 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:982
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Image.cpp:718
void setName(std::shared_ptr< std::string > &name)
Set the Name property.
Definition: Image.cpp:661
std::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Image.cpp:768
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Image.h:96
Image & operator=(const Image &)
Assignment operator (deleted).
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:1263
bool unlinkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: Image.cpp:1189
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Image.cpp:1472
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:526
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:303
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Image.cpp:1030
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:1131
void setStageLabel(std::shared_ptr< ome::xml::model::StageLabel > &stageLabel)
Set the StageLabel property.
Definition: Image.cpp:882
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:1048
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:1118
void setObjectiveSettings(std::shared_ptr< ome::xml::model::ObjectiveSettings > &objectiveSettings)
Set the ObjectiveSettings property.
Definition: Image.cpp:840
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Image.cpp:1096
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:1224
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:1072
void setImagingEnvironment(std::shared_ptr< ome::xml::model::ImagingEnvironment > &imagingEnvironment)
Set the ImagingEnvironment property.
Definition: Image.cpp:861
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:1108
bool unlinkWellSample(const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Image.cpp:1247
bool unlinkMicrobeamManipulation(const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Unlink MicrobeamManipulation.
Definition: Image.cpp:1012
void setID(const std::string &id)
Set the ID property.
Definition: Image.cpp:640
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Image.cpp:1154
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:1218
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Image.cpp:1090
bool linkWellSample(const std::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Image.cpp:1234
std::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Image.cpp:689
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:325
void setPixels(std::shared_ptr< ome::xml::model::Pixels > &pixels)
Set the Pixels property.
Definition: Image.cpp:903
Image()
Default constructor.
Definition: Image.cpp:283
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:1176
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Image.cpp:910
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 setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Image.cpp:732
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:928
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:988
void linkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Image.cpp:702
const std::string & elementName() const
Get the element name of this model object.
Definition: Image.cpp:312
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Image.cpp:1036
std::shared_ptr< ome::xml::model::ObjectiveSettings > getObjectiveSettings()
Get the ObjectiveSettings property.
Definition: Image.cpp:826
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: Image.cpp:976
void linkInstrument(std::shared_ptr< ome::xml::model::Instrument > &instrument)
Link Instrument.
Definition: Image.cpp:810
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Image.cpp:916
void unlinkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Image.cpp:787
OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type::size_type sizeOfLinkedWellSampleList() const
Get size of linked WellSample list.
Definition: Image.cpp:1206
std::weak_ptr< ome::xml::model::Experiment > getLinkedExperiment()
Get linked Experiment.
Definition: Image.cpp:739
virtual ~Image()
Destructor.
Definition: Image.cpp:298
std::weak_ptr< ome::xml::model::Instrument > getLinkedInstrument()
Get linked Instrument.
Definition: Image.cpp:797
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Image.cpp:1058
bool unlinkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Image.cpp:952
void setAcquisitionDate(std::shared_ptr< ome::xml::model::primitives::Timestamp > &acquisitionDate)
Set the AcquisitionDate property.
Definition: Image.cpp:682
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: Image.cpp:1148
const std::string & getID() const
Get the ID property.
Definition: Image.cpp:633
std::shared_ptr< ome::xml::model::primitives::Timestamp > getAcquisitionDate()
Get the AcquisitionDate property.
Definition: Image.cpp:668
void linkExperimenterGroup(std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Image.cpp:781
void linkExperiment(std::shared_ptr< ome::xml::model::Experiment > &experiment)
Link Experiment.
Definition: Image.cpp:752
std::shared_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Image.cpp:889
OMEModelObject::indexed_container< ome::xml::model::WellSample, std::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Image.cpp:1212
void unlinkInstrument(std::shared_ptr< ome::xml::model::Instrument > &instrument)
Unlink Instrument.
Definition: Image.cpp:816
bool linkMicrobeamManipulation(const std::shared_ptr< ome::xml::model::MicrobeamManipulation > µbeamManipulation)
Link MicrobeamManipulation.
Definition: Image.cpp:998
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:922
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:1042
bool linkROI(const std::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Image.cpp:938
std::shared_ptr< ome::xml::model::StageLabel > getStageLabel()
Get the StageLabel property.
Definition: Image.cpp:868
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:1160
void unlinkExperiment(std::shared_ptr< ome::xml::model::Experiment > &experiment)
Unlink Experiment.
Definition: Image.cpp:758
std::shared_ptr< ome::xml::model::ImagingEnvironment > getImagingEnvironment()
Get the ImagingEnvironment property.
Definition: Image.cpp:847
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:1102
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, std::weak_ptr >::type::size_type sizeOfLinkedMicrobeamManipulationList() const
Get size of linked MicrobeamManipulation list.
Definition: Image.cpp:970
void unlinkExperimenter(std::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Image.cpp:708
std::shared_ptr< std::string > getName()
Get the Name property.
Definition: Image.cpp:647
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:1166