ome-xml 5.2.3

Image.h
1 /*
2 * #%L
3 * OME-XML C++ library for working with OME-XML metadata structures.
4 * %%
5 * Copyright © 2006 - 2016 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 /*─────────────────────────────────────────────────────────────────────────────
40 *
41 * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42 *
43 *─────────────────────────────────────────────────────────────────────────────
44 */
45
46 #ifndef OME_XML_MODEL_IMAGE_H
47 #define OME_XML_MODEL_IMAGE_H
48
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54
55 #include <ome/common/log.h>
56
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>
61
62 #include <ome/xml/model/primitives/Quantity.h>
63
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>
74
75 namespace ome
76 {
77 namespace xml
78 {
79 namespace model
80 {
81
82 // Forward declarations.
83 class Annotation;
84 class Dataset;
85 class Folder;
86 class MicrobeamManipulation;
87 class OMEModel;
88 class ROI;
89 class WellSample;
90
94 class Image : public detail::OMEModelObject
95 {
96 private:
97 class Impl;
99 ome::compat::shared_ptr<Impl> impl;
100
101 public:
103 Image();
104
110 Image (const Image& copy);
111
113 virtual
114 ~Image ();
115
130 static ome::compat::shared_ptr< Image>
131 create(const common::xml::dom::Element& element,
132 ome::xml::model::OMEModel& model);
133
134 // Documented in superclass.
135 const std::string&
136 elementName() const;
137
138 // Documented in superclass.
139 bool
140 validElementName(const std::string& name) const;
141
142 private:
144 Image&
145 operator= (const Image&);
146
147 public:
148 // -- OMEModelObject API methods --
149
151 virtual void
152 update(const common::xml::dom::Element& element,
153 ome::xml::model::OMEModel& model);
154
155 public:
156 // -- Image API methods --
157
159 bool
160 link (ome::compat::shared_ptr<Reference>& reference,
161 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
162
168 const std::string&
169 getID () const;
170
176 void
177 setID (const std::string& id);
178
184 ome::compat::shared_ptr<std::string>
185 getName ();
186
192 const ome::compat::shared_ptr<std::string>
193 getName () const;
194
200 void
201 setName (ome::compat::shared_ptr<std::string>& name);
202
208 ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
209 getAcquisitionDate ();
210
216 const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
217 getAcquisitionDate () const;
218
224 void
225 setAcquisitionDate (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& acquisitionDate);
226
233 ome::compat::weak_ptr<ome::xml::model::Experimenter>
234 getLinkedExperimenter ();
235
242 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
243 getLinkedExperimenter () const;
244
250 void
251 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
252
262 void
263 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
264
270 ome::compat::shared_ptr<std::string>
271 getDescription ();
272
278 const ome::compat::shared_ptr<std::string>
279 getDescription () const;
280
286 void
287 setDescription (ome::compat::shared_ptr<std::string>& description);
288
295 ome::compat::weak_ptr<ome::xml::model::Experiment>
296 getLinkedExperiment ();
297
304 const ome::compat::weak_ptr<ome::xml::model::Experiment>
305 getLinkedExperiment () const;
306
312 void
313 linkExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
314
324 void
325 unlinkExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
326
333 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
334 getLinkedExperimenterGroup ();
335
342 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
343 getLinkedExperimenterGroup () const;
344
350 void
351 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
352
362 void
363 unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
364
371 ome::compat::weak_ptr<ome::xml::model::Instrument>
372 getLinkedInstrument ();
373
380 const ome::compat::weak_ptr<ome::xml::model::Instrument>
381 getLinkedInstrument () const;
382
388 void
389 linkInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
390
400 void
401 unlinkInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
402
408 ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>
409 getObjectiveSettings ();
410
416 const ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>
417 getObjectiveSettings () const;
418
424 void
425 setObjectiveSettings (ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>& objectiveSettings);
426
432 ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>
433 getImagingEnvironment ();
434
440 const ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>
441 getImagingEnvironment () const;
442
448 void
449 setImagingEnvironment (ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>& imagingEnvironment);
450
456 ome::compat::shared_ptr<ome::xml::model::StageLabel>
457 getStageLabel ();
458
464 const ome::compat::shared_ptr<ome::xml::model::StageLabel>
465 getStageLabel () const;
466
472 void
473 setStageLabel (ome::compat::shared_ptr<ome::xml::model::StageLabel>& stageLabel);
474
480 ome::compat::shared_ptr<ome::xml::model::Pixels>
481 getPixels ();
482
488 const ome::compat::shared_ptr<ome::xml::model::Pixels>
489 getPixels () const;
490
496 void
497 setPixels (ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels);
498
504 OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type::size_type
505 sizeOfLinkedROIList () const;
506
512 OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type
513 getLinkedROIList () const;
514
522 const ome::compat::weak_ptr<ome::xml::model::ROI>&
523 getLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type::size_type index) const;
524
535 const ome::compat::weak_ptr<ome::xml::model::ROI>&
536 setLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, ome::compat::weak_ptr>::type::size_type index,
537 const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
538
549 bool
550 linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
551
567 bool
568 unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
569
575 OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type
576 sizeOfLinkedMicrobeamManipulationList () const;
577
583 OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type
584 getLinkedMicrobeamManipulationList () const;
585
593 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
594 getLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type index) const;
595
606 const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
607 setLinkedMicrobeamManipulation (OMEModelObject::indexed_container<ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr>::type::size_type index,
608 const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
609
620 bool
621 linkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
622
638 bool
639 unlinkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
640
646 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
647 sizeOfLinkedAnnotationList () const;
648
654 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
655 getLinkedAnnotationList () const;
656
664 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
665 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
666
677 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
678 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
679 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
680
691 bool
692 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
693
709 bool
710 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
711
717 OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type
718 sizeOfLinkedDatasetList () const;
719
725 OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type
726 getLinkedDatasetList () const;
727
735 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
736 getLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type index) const;
737
748 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
749 setLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type index,
750 const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
751
762 bool
763 linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
764
780 bool
781 unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
782
788 OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type::size_type
789 sizeOfLinkedFolderList () const;
790
796 OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type
797 getLinkedFolderList () const;
798
806 const ome::compat::weak_ptr<ome::xml::model::Folder>&
807 getLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type::size_type index) const;
808
819 const ome::compat::weak_ptr<ome::xml::model::Folder>&
820 setLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, ome::compat::weak_ptr>::type::size_type index,
821 const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
822
833 bool
834 linkFolder (const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
835
851 bool
852 unlinkFolder (const ome::compat::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
853
859 OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type
860 sizeOfLinkedWellSampleList () const;
861
867 OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type
868 getLinkedWellSampleList () const;
869
877 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
878 getLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type index) const;
879
890 const ome::compat::weak_ptr<ome::xml::model::WellSample>&
891 setLinkedWellSample (OMEModelObject::indexed_container<ome::xml::model::WellSample, ome::compat::weak_ptr>::type::size_type index,
892 const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
893
904 bool
905 linkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
906
922 bool
923 unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
924
926 virtual common::xml::dom::Element
927 asXMLElement (common::xml::dom::Document& document) const;
928
929
930 protected:
931 // Documented in base class.
932 virtual common::xml::dom::Element
933 asXMLElementInternal (common::xml::dom::Document& document,
934 common::xml::dom::Element& element) const;
935
936 public:
937 // Documented in superclass.
938 const std::string&
939 getXMLNamespace() const;
940 };
941
942 }
943 }
944 }
945
946 #endif // OME_XML_MODEL_IMAGE_H
947
948 /*
949 * Local Variables:
950 * mode:C++
951 * End:
952 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Image::getLinkedMicrobeamManipulation
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
ome::xml::model::Image::setLinkedWellSample
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
ome::xml::model::Image::asXMLElementInternal
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
ome::xml::model::Image::setStageLabel
void setStageLabel(ome::compat::shared_ptr< ome::xml::model::StageLabel > &stageLabel)
Set the StageLabel property.
Definition: Image.cpp:898
ome::xml::model::Image::sizeOfLinkedROIList
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::xml::model::Image::getPixels
ome::compat::shared_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Image.cpp:905
ome::xml::model::Image::operator=
Image & operator=(const Image &)
Assignment operator (deleted).
ome::xml::model::Image::getAcquisitionDate
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getAcquisitionDate()
Get the AcquisitionDate property.
Definition: Image.cpp:684
ome::xml::model::Image::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Image.cpp:1074
ome::xml::model::Image::unlinkExperiment
void unlinkExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Unlink Experiment.
Definition: Image.cpp:774
ome::xml::model::Image::getLinkedExperimenter
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Image.cpp:705
ome::xml::model::Image::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Image.cpp:1524
ome::xml::model::Image::unlinkFolder
bool unlinkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: Image.cpp:1205
ome::xml::model::Image::setImagingEnvironment
void setImagingEnvironment(ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > &imagingEnvironment)
Set the ImagingEnvironment property.
Definition: Image.cpp:877
ome::xml::model::Image::linkInstrument
void linkInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Link Instrument.
Definition: Image.cpp:826
ome::xml::model::Image::linkWellSample
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Image.cpp:1250
ome::xml::model::Image::unlinkROI
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Image.cpp:968
ome::xml::model::Image::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Image.cpp:663
ome::xml::model::Image::setLinkedDataset
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
ome::xml::model::Image::linkExperiment
void linkExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Link Experiment.
Definition: Image.cpp:768
ome::common::xml::dom::Document
ome::xml::model::Image::unlinkExperimenter
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Image.cpp:724
ome::xml::model::Image::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Image.cpp:734
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Image::sizeOfLinkedMicrobeamManipulationList
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
ome::xml::model::Image
Image model object.
Definition: Image.h:94
ome::xml::model::Image::getStageLabel
ome::compat::shared_ptr< ome::xml::model::StageLabel > getStageLabel()
Get the StageLabel property.
Definition: Image.cpp:884
ome::xml::model::OMEModelObject::indexed_container::type
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
ome::xml::model::Image::unlinkInstrument
void unlinkInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Unlink Instrument.
Definition: Image.cpp:832
ome::xml::model::Image::linkDataset
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Image.cpp:1134
ome::xml::model::Image::getLinkedROI
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
ome::xml::model::Image::getLinkedROIList
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Image.cpp:932
ome::xml::model::Image::getLinkedFolder
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
ome::xml::model::Image::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Image.cpp:1052
ome::xml::model::Image::Impl
Private implementation details of Image model object.
Definition: Image.cpp:125
ome::xml::model::Image::setID
void setID(const std::string &id)
Set the ID property.
Definition: Image.cpp:656
ome::xml::model::Image::linkMicrobeamManipulation
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Link MicrobeamManipulation.
Definition: Image.cpp:1014
ome::xml::model::Image::update
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
ome::xml::model::Image::Image
Image()
Default constructor.
Definition: Image.cpp:283
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::xml::model::Image::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Image.cpp:677
ome::xml::model::Image::validElementName
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
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Image::unlinkExperimenterGroup
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Image.cpp:803
ome::xml::model::Image::setAcquisitionDate
void setAcquisitionDate(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &acquisitionDate)
Set the AcquisitionDate property.
Definition: Image.cpp:698
ome::xml::model::Image::getLinkedInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getLinkedInstrument()
Get linked Instrument.
Definition: Image.cpp:813
ome::xml::model::Image::setLinkedAnnotation
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
ome::xml::model::Image::sizeOfLinkedAnnotationList
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
ome::xml::model::Image::linkROI
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Image.cpp:954
ome::xml::model::Image::unlinkWellSample
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Image.cpp:1263
ome::xml::model::Image::getLinkedExperimenterGroup
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Image.cpp:784
ome::xml::model::Image::unlinkDataset
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Image.cpp:1147
ome::xml::model::Image::setPixels
void setPixels(ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels)
Set the Pixels property.
Definition: Image.cpp:919
ome::xml::model::Image::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Image.cpp:312
ome::xml::model::Image::linkExperimenterGroup
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Image.cpp:797
ome::xml::model::Image::getLinkedMicrobeamManipulationList
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: Image.cpp:992
ome::xml::model::Image::sizeOfLinkedDatasetList
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
ome::xml::model::Image::getLinkedFolderList
OMEModelObject::indexed_container< ome::xml::model::Folder, ome::compat::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Image.cpp:1170
ome::xml::model::Image::getObjectiveSettings
ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > getObjectiveSettings()
Get the ObjectiveSettings property.
Definition: Image.cpp:842
ome::xml::model::Image::setLinkedROI
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
ome::xml::model::Image::~Image
virtual ~Image()
Destructor.
Definition: Image.cpp:298
ome::xml::model::Image::unlinkMicrobeamManipulation
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Unlink MicrobeamManipulation.
Definition: Image.cpp:1028
ome::xml::model::Image::sizeOfLinkedWellSampleList
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
ome::xml::model::Image::getID
const std::string & getID() const
Get the ID property.
Definition: Image.cpp:649
ome::xml::model::Image::getLinkedDataset
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
ome::xml::model::Image::getLinkedWellSample
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
ome::xml::model::Image::linkExperimenter
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Image.cpp:718
ome::xml::model::Image::getLinkedDatasetList
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Image.cpp:1112
ome::xml::model::Image::sizeOfLinkedFolderList
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
ome::xml::model::Image::linkFolder
bool linkFolder(const ome::compat::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: Image.cpp:1192
ome::xml::model::Image::getLinkedExperiment
ome::compat::weak_ptr< ome::xml::model::Experiment > getLinkedExperiment()
Get linked Experiment.
Definition: Image.cpp:755
ome::xml::model::Image::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Image.h:97
ome::xml::model::Image::create
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
ome::xml::model::Image::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Image.cpp:748
ome::xml::model::Image::setLinkedMicrobeamManipulation
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 > &microbeamManipulation)
Set linked MicrobeamManipulation.
Definition: Image.cpp:1004
ome::xml::model::Image::link
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
ome::xml::model::Image::asXMLElement
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
log.h
ome::xml::model::Image::getLinkedAnnotation
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::xml::model::Image::getImagingEnvironment
ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > getImagingEnvironment()
Get the ImagingEnvironment property.
Definition: Image.cpp:863
ome::xml::model::Image::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Image.cpp:1088
ome::xml::model::Image::setObjectiveSettings
void setObjectiveSettings(ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > &objectiveSettings)
Set the ObjectiveSettings property.
Definition: Image.cpp:856
ome::xml::model::Image::getLinkedWellSampleList
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Image.cpp:1228
ome::xml::model::Image::setLinkedFolder
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