bioformats  5.1.2
Image.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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/Experiment.h>
63 #include <ome/xml/model/Experimenter.h>
64 #include <ome/xml/model/ExperimenterGroup.h>
65 #include <ome/xml/model/ImagingEnvironment.h>
66 #include <ome/xml/model/Instrument.h>
67 #include <ome/xml/model/ObjectiveSettings.h>
68 #include <ome/xml/model/Pixels.h>
69 #include <ome/xml/model/StageLabel.h>
70 #include <ome/xml/model/detail/OMEModelObject.h>
71 #include <ome/xml/model/primitives/Timestamp.h>
72 
73 namespace ome
74 {
75  namespace xml
76  {
77  namespace model
78  {
79 
80  // Forward declarations.
81  class Annotation;
82  class Dataset;
83  class MicrobeamManipulation;
84  class OMEModel;
85  class ROI;
86  class WellSample;
87 
92  {
93  private:
95  std::string id;
97  ome::compat::shared_ptr<std::string> name;
99  ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp> acquisitionDate;
101  ome::compat::weak_ptr<ome::xml::model::Experimenter> experimenter;
103  ome::compat::shared_ptr<std::string> description;
105  ome::compat::weak_ptr<ome::xml::model::Experiment> experiment;
107  ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup> experimenterGroup;
109  ome::compat::weak_ptr<ome::xml::model::Instrument> instrument;
111  ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings> objectiveSettings;
113  ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment> imagingEnvironment;
115  ome::compat::shared_ptr<ome::xml::model::StageLabel> stageLabel;
117  ome::compat::shared_ptr<ome::xml::model::Pixels> pixels;
128 
129  public:
131  Image ();
132 
138  Image (const Image& copy);
139 
141  virtual
142  ~Image ();
143 
144 
145 
160  static ome::compat::shared_ptr< Image>
161  create(const common::xml::dom::Element& element,
163 
164  // Documented in superclass.
165  const std::string&
166  elementName() const;
167 
168  // Documented in superclass.
169  bool
170  validElementName(const std::string& name) const;
171 
172 
173  // -- OMEModelObject API methods --
174 
176  virtual void
177  update(const common::xml::dom::Element& element,
179 
180  public:
181  // -- Image API methods --
182 
184  bool
185  link (ome::compat::shared_ptr<Reference>& reference,
186  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
187 
193  const std::string&
194  getID () const;
195 
201  void
202  setID (const std::string& id);
203 
209  ome::compat::shared_ptr<std::string>
210  getName ();
211 
217  const ome::compat::shared_ptr<std::string>
218  getName () const;
219 
225  void
226  setName (ome::compat::shared_ptr<std::string>& name);
227 
233  ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
235 
241  const ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>
242  getAcquisitionDate () const;
243 
249  void
250  setAcquisitionDate (ome::compat::shared_ptr<ome::xml::model::primitives::Timestamp>& acquisitionDate);
251 
258  ome::compat::weak_ptr<ome::xml::model::Experimenter>
260 
267  const ome::compat::weak_ptr<ome::xml::model::Experimenter>
268  getLinkedExperimenter () const;
269 
275  void
276  linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
277 
287  void
288  unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
289 
295  ome::compat::shared_ptr<std::string>
296  getDescription ();
297 
303  const ome::compat::shared_ptr<std::string>
304  getDescription () const;
305 
311  void
312  setDescription (ome::compat::shared_ptr<std::string>& description);
313 
320  ome::compat::weak_ptr<ome::xml::model::Experiment>
322 
329  const ome::compat::weak_ptr<ome::xml::model::Experiment>
330  getLinkedExperiment () const;
331 
337  void
338  linkExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
339 
349  void
350  unlinkExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
351 
358  ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
360 
367  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
369 
375  void
376  linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
377 
387  void
388  unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
389 
396  ome::compat::weak_ptr<ome::xml::model::Instrument>
398 
405  const ome::compat::weak_ptr<ome::xml::model::Instrument>
406  getLinkedInstrument () const;
407 
413  void
414  linkInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
415 
425  void
426  unlinkInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
427 
433  ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>
435 
441  const ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>
442  getObjectiveSettings () const;
443 
449  void
450  setObjectiveSettings (ome::compat::shared_ptr<ome::xml::model::ObjectiveSettings>& objectiveSettings);
451 
457  ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>
459 
465  const ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>
466  getImagingEnvironment () const;
467 
473  void
474  setImagingEnvironment (ome::compat::shared_ptr<ome::xml::model::ImagingEnvironment>& imagingEnvironment);
475 
481  ome::compat::shared_ptr<ome::xml::model::StageLabel>
482  getStageLabel ();
483 
489  const ome::compat::shared_ptr<ome::xml::model::StageLabel>
490  getStageLabel () const;
491 
497  void
498  setStageLabel (ome::compat::shared_ptr<ome::xml::model::StageLabel>& stageLabel);
499 
505  ome::compat::shared_ptr<ome::xml::model::Pixels>
506  getPixels ();
507 
513  const ome::compat::shared_ptr<ome::xml::model::Pixels>
514  getPixels () const;
515 
521  void
522  setPixels (ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels);
523 
530  sizeOfLinkedROIList () const;
531 
538  getLinkedROIList () const;
539 
547  const ome::compat::weak_ptr<ome::xml::model::ROI>&
549 
560  const ome::compat::weak_ptr<ome::xml::model::ROI>&
562  const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
563 
574  bool
575  linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
576 
592  bool
593  unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
594 
602 
610 
618  const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
620 
631  const ome::compat::weak_ptr<ome::xml::model::MicrobeamManipulation>&
633  const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
634 
645  bool
646  linkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
647 
663  bool
664  unlinkMicrobeamManipulation (const ome::compat::shared_ptr<ome::xml::model::MicrobeamManipulation>& microbeamManipulation);
665 
673 
680  getLinkedAnnotationList () const;
681 
689  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
691 
702  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
704  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
705 
716  bool
717  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
718 
734  bool
735  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
736 
743  sizeOfLinkedDatasetList () const;
744 
751  getLinkedDatasetList () const;
752 
760  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
762 
773  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
775  const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
776 
787  bool
788  linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
789 
805  bool
806  unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
807 
815 
822  getLinkedWellSampleList () const;
823 
831  const ome::compat::weak_ptr<ome::xml::model::WellSample>&
833 
844  const ome::compat::weak_ptr<ome::xml::model::WellSample>&
846  const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
847 
858  bool
859  linkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
860 
876  bool
877  unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
878 
879 
882  asXMLElement (common::xml::dom::Document& document) const;
883 
884 
885  protected:
886  // Documented in base class.
889  common::xml::dom::Element& element) const;
890 
891  public:
892  // Documented in superclass.
893  const std::string&
894  getXMLNamespace() const;
895  };
896 
897  }
898  }
899 }
900 
901 #endif // OME_XML_MODEL_IMAGE_H
902 
903 /*
904  * Local Variables:
905  * mode:C++
906  * End:
907  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type microbeamManipulationLinks
MicrobeamManipulationRef reference (occurs more than once)
Definition: Image.h:121
ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > objectiveSettings
ObjectiveSettings property.
Definition: Image.h:111
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:1127
OMEModelObject::indexed_container< ome::xml::model::MicrobeamManipulation, ome::compat::weak_ptr >::type getLinkedMicrobeamManipulationList() const
Get the linked MicrobeamManipulation list.
Definition: Image.cpp:937
ome::compat::shared_ptr< ome::xml::model::Pixels > pixels
Pixels property.
Definition: Image.h:117
void setStageLabel(ome::compat::shared_ptr< ome::xml::model::StageLabel > &stageLabel)
Set the StageLabel property.
Definition: Image.cpp:843
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:871
ome::compat::shared_ptr< ome::xml::model::Pixels > getPixels()
Get the Pixels property.
Definition: Image.cpp:850
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > getAcquisitionDate()
Get the AcquisitionDate property.
Definition: Image.cpp:629
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Image.cpp:1019
void unlinkExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Unlink Experiment.
Definition: Image.cpp:719
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Image.cpp:650
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:1063
ome::compat::shared_ptr< ome::xml::model::StageLabel > stageLabel
StageLabel property.
Definition: Image.h:115
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Image.cpp:877
std::string id
ID property.
Definition: Image.h:95
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:1174
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: Image.h:123
void setImagingEnvironment(ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > &imagingEnvironment)
Set the ImagingEnvironment property.
Definition: Image.cpp:822
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:1121
void linkInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Link Instrument.
Definition: Image.cpp:771
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > experimenterGroup
ExperimenterGroupRef reference.
Definition: Image.h:107
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:991
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Image.cpp:1137
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Unlink ROI.
Definition: Image.cpp:913
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Image.cpp:608
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Image.cpp:997
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:1069
void linkExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Link Experiment.
Definition: Image.cpp:713
DOM Document wrapper.
Definition: Document.h:82
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Image.cpp:669
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Image.cpp:679
ome::compat::shared_ptr< std::string > description
Description property.
Definition: Image.h:103
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
Image model object.
Definition: Image.h:91
ome::compat::shared_ptr< ome::xml::model::StageLabel > getStageLabel()
Get the StageLabel property.
Definition: Image.cpp:829
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
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:883
void unlinkInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Unlink Instrument.
Definition: Image.cpp:777
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Image.cpp:1079
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type datasetLinks
Dataset_BackReference back reference (occurs more than once)
Definition: Image.h:125
void setID(const std::string &id)
Set the ID property.
Definition: Image.cpp:601
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Image.cpp:1057
bool linkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Link MicrobeamManipulation.
Definition: Image.cpp:959
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:273
Image()
Default constructor.
Definition: Image.cpp:192
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:622
ome::compat::weak_ptr< ome::xml::model::Experiment > experiment
ExperimentRef reference.
Definition: Image.h:105
ome::compat::weak_ptr< ome::xml::model::Instrument > instrument
InstrumentRef reference.
Definition: Image.h:109
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Image.cpp:748
void setAcquisitionDate(ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > &acquisitionDate)
Set the AcquisitionDate property.
Definition: Image.cpp:643
ome::compat::weak_ptr< ome::xml::model::Instrument > getLinkedInstrument()
Get linked Instrument.
Definition: Image.cpp:758
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:1009
const std::string & getID() const
Get the ID property.
Definition: Image.cpp:594
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type wellSamples
WellSample_BackReference back reference (occurs more than once)
Definition: Image.h:127
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Link ROI.
Definition: Image.cpp:899
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Image.cpp:1150
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Image.cpp:729
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Image.cpp:1092
void setPixels(ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels)
Set the Pixels property.
Definition: Image.cpp:864
ome::compat::shared_ptr< ome::xml::model::primitives::Timestamp > acquisitionDate
AcquisitionDate property.
Definition: Image.h:99
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Image.cpp:742
ome::compat::weak_ptr< ome::xml::model::Experimenter > experimenter
ExperimenterRef reference.
Definition: Image.h:101
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type roiLinks
ROIRef reference (occurs more than once)
Definition: Image.h:119
ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > getObjectiveSettings()
Get the ObjectiveSettings property.
Definition: Image.cpp:787
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:889
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Image.cpp:264
virtual ~Image()
Destructor.
Definition: Image.cpp:243
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:943
ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > imagingEnvironment
ImagingEnvironment property.
Definition: Image.h:113
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:1051
bool unlinkMicrobeamManipulation(const ome::compat::shared_ptr< ome::xml::model::MicrobeamManipulation > &microbeamManipulation)
Unlink MicrobeamManipulation.
Definition: Image.cpp:973
ome::compat::shared_ptr< std::string > name
Name property.
Definition: Image.h:97
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Image.cpp:663
ome::compat::weak_ptr< ome::xml::model::Experiment > getLinkedExperiment()
Get linked Experiment.
Definition: Image.cpp:700
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:248
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Image.cpp:693
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:1003
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Image.cpp:1410
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:1167
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:1109
Boost.Log compatibility.
const std::string & elementName() const
Get the element name of this model object.
Definition: Image.cpp:257
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:949
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:487
ome::compat::shared_ptr< ome::xml::model::ImagingEnvironment > getImagingEnvironment()
Get the ImagingEnvironment property.
Definition: Image.cpp:808
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Image.cpp:1033
void setObjectiveSettings(ome::compat::shared_ptr< ome::xml::model::ObjectiveSettings > &objectiveSettings)
Set the ObjectiveSettings property.
Definition: Image.cpp:801
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:931
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Image.cpp:1115
Xerces-C modern C++ wrapper.
Definition: Base.h:53