bioformats  5.1.0
OME.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_OME_H
47 #define OME_XML_MODEL_OME_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/BinaryOnly.h>
63 #include <ome/xml/model/Rights.h>
64 #include <ome/xml/model/StructuredAnnotations.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66 
67 namespace ome
68 {
69  namespace xml
70  {
71  namespace model
72  {
73 
74  // Forward declarations.
75  class Dataset;
76  class Experiment;
77  class Experimenter;
78  class ExperimenterGroup;
79  class Image;
80  class Instrument;
81  class OMEModel;
82  class Plate;
83  class Project;
84  class ROI;
85  class Screen;
86 
90  class OME : public detail::OMEModelObject
91  {
92  private:
94  ome::compat::shared_ptr<std::string> uuid;
96  ome::compat::shared_ptr<std::string> creator;
98  ome::compat::shared_ptr<ome::xml::model::Rights> rights;
100  std::vector<ome::compat::shared_ptr<ome::xml::model::Project> > projects;
102  std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> > datasets;
104  std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> > experiments;
106  std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> > plates;
108  std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> > screens;
110  std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> > experimenters;
112  std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> > experimenterGroups;
114  std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> > instruments;
116  std::vector<ome::compat::shared_ptr<ome::xml::model::Image> > images;
118  ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations> structuredAnnotations;
120  std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> > roIs;
122  ome::compat::shared_ptr<ome::xml::model::BinaryOnly> binaryOnly;
123 
124  public:
126  OME ();
127 
133  OME (const OME& copy);
134 
136  virtual
137  ~OME ();
138 
139 
140 
155  static ome::compat::shared_ptr< OME>
156  create(const common::xml::dom::Element& element,
158 
159  // Documented in superclass.
160  const std::string&
161  elementName() const;
162 
163  // Documented in superclass.
164  bool
165  validElementName(const std::string& name) const;
166 
167 
168  // -- OMEModelObject API methods --
169 
171  virtual void
172  update(const common::xml::dom::Element& element,
174 
175  public:
176  // -- OME API methods --
177 
179  bool
180  link (ome::compat::shared_ptr<Reference>& reference,
181  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
182 
188  ome::compat::shared_ptr<std::string>
189  getUUID ();
190 
196  const ome::compat::shared_ptr<std::string>
197  getUUID () const;
198 
204  void
205  setUUID (ome::compat::shared_ptr<std::string>& uuid);
206 
212  ome::compat::shared_ptr<std::string>
213  getCreator ();
214 
220  const ome::compat::shared_ptr<std::string>
221  getCreator () const;
222 
228  void
229  setCreator (ome::compat::shared_ptr<std::string>& creator);
230 
236  ome::compat::shared_ptr<ome::xml::model::Rights>
237  getRights ();
238 
244  const ome::compat::shared_ptr<ome::xml::model::Rights>
245  getRights () const;
246 
252  void
253  setRights (ome::compat::shared_ptr<ome::xml::model::Rights>& rights);
254 
260  std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type
261  sizeOfProjectList () const;
262 
269  std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
270  getProjectList ();
271 
278  const std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
279  getProjectList () const;
280 
288  ome::compat::shared_ptr<ome::xml::model::Project>&
289  getProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index);
290 
298  const ome::compat::shared_ptr<ome::xml::model::Project>&
299  getProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index) const;
300 
308  void
309  setProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index,
310  ome::compat::shared_ptr<ome::xml::model::Project>& project);
311 
320  void
321  addProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);
322 
332  void
333  removeProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);
334 
340  std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type
341  sizeOfDatasetList () const;
342 
349  std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
350  getDatasetList ();
351 
358  const std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
359  getDatasetList () const;
360 
368  ome::compat::shared_ptr<ome::xml::model::Dataset>&
369  getDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index);
370 
378  const ome::compat::shared_ptr<ome::xml::model::Dataset>&
379  getDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index) const;
380 
388  void
389  setDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index,
390  ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
391 
400  void
401  addDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
402 
412  void
413  removeDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
414 
420  std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type
421  sizeOfExperimentList () const;
422 
429  std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
431 
438  const std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
439  getExperimentList () const;
440 
448  ome::compat::shared_ptr<ome::xml::model::Experiment>&
449  getExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index);
450 
458  const ome::compat::shared_ptr<ome::xml::model::Experiment>&
459  getExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index) const;
460 
468  void
469  setExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index,
470  ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
471 
480  void
481  addExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
482 
492  void
493  removeExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
494 
500  std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type
501  sizeOfPlateList () const;
502 
509  std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
510  getPlateList ();
511 
518  const std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
519  getPlateList () const;
520 
528  ome::compat::shared_ptr<ome::xml::model::Plate>&
529  getPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index);
530 
538  const ome::compat::shared_ptr<ome::xml::model::Plate>&
539  getPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index) const;
540 
548  void
549  setPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index,
550  ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
551 
560  void
561  addPlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
562 
572  void
573  removePlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
574 
580  std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type
581  sizeOfScreenList () const;
582 
589  std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
590  getScreenList ();
591 
598  const std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
599  getScreenList () const;
600 
608  ome::compat::shared_ptr<ome::xml::model::Screen>&
609  getScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index);
610 
618  const ome::compat::shared_ptr<ome::xml::model::Screen>&
619  getScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index) const;
620 
628  void
629  setScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index,
630  ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
631 
640  void
641  addScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
642 
652  void
653  removeScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
654 
660  std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type
661  sizeOfExperimenterList () const;
662 
669  std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
671 
678  const std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
679  getExperimenterList () const;
680 
688  ome::compat::shared_ptr<ome::xml::model::Experimenter>&
689  getExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index);
690 
698  const ome::compat::shared_ptr<ome::xml::model::Experimenter>&
699  getExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index) const;
700 
708  void
709  setExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index,
710  ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
711 
720  void
721  addExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
722 
732  void
733  removeExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
734 
740  std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type
742 
749  std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
751 
758  const std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
759  getExperimenterGroupList () const;
760 
768  ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>&
769  getExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index);
770 
778  const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>&
779  getExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index) const;
780 
788  void
789  setExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index,
790  ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
791 
800  void
801  addExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
802 
812  void
813  removeExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
814 
820  std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type
821  sizeOfInstrumentList () const;
822 
829  std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
831 
838  const std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
839  getInstrumentList () const;
840 
848  ome::compat::shared_ptr<ome::xml::model::Instrument>&
849  getInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index);
850 
858  const ome::compat::shared_ptr<ome::xml::model::Instrument>&
859  getInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index) const;
860 
868  void
869  setInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index,
870  ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
871 
880  void
881  addInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
882 
892  void
893  removeInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
894 
900  std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type
901  sizeOfImageList () const;
902 
909  std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
910  getImageList ();
911 
918  const std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
919  getImageList () const;
920 
928  ome::compat::shared_ptr<ome::xml::model::Image>&
929  getImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index);
930 
938  const ome::compat::shared_ptr<ome::xml::model::Image>&
939  getImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index) const;
940 
948  void
949  setImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index,
950  ome::compat::shared_ptr<ome::xml::model::Image>& image);
951 
960  void
961  addImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
962 
972  void
973  removeImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
974 
980  ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
982 
988  const ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
989  getStructuredAnnotations () const;
990 
996  void
997  setStructuredAnnotations (ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations);
998 
1004  std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type
1005  sizeOfROIList () const;
1006 
1013  std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
1014  getROIList ();
1015 
1022  const std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
1023  getROIList () const;
1024 
1032  ome::compat::shared_ptr<ome::xml::model::ROI>&
1033  getROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index);
1034 
1042  const ome::compat::shared_ptr<ome::xml::model::ROI>&
1043  getROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index) const;
1044 
1052  void
1053  setROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index,
1054  ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1055 
1064  void
1065  addROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1066 
1076  void
1077  removeROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1078 
1084  ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
1085  getBinaryOnly ();
1086 
1092  const ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
1093  getBinaryOnly () const;
1094 
1100  void
1101  setBinaryOnly (ome::compat::shared_ptr<ome::xml::model::BinaryOnly>& binaryOnly);
1102 
1103 
1106  asXMLElement (common::xml::dom::Document& document) const;
1107 
1108 
1109  protected:
1110  // Documented in base class.
1113  common::xml::dom::Element& element) const;
1114 
1115  public:
1116  // Documented in superclass.
1117  const std::string&
1118  getXMLNamespace() const;
1119  };
1120 
1121  }
1122  }
1123 }
1124 
1125 #endif // OME_XML_MODEL_OME_H
1126 
1127 /*
1128  * Local Variables:
1129  * mode:C++
1130  * End:
1131  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< ome::xml::model::Instrument > & getInstrument(std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > >::size_type index)
Get Instrument.
Definition: OME.cpp:999
void setProject(std::vector< ome::compat::shared_ptr< ome::xml::model::Project > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Project > &project)
Set Project.
Definition: OME.cpp:633
void addDataset(ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Add Dataset.
Definition: OME.cpp:694
void setExperimenterGroup(std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > >::size_type index, ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Set ExperimenterGroup.
Definition: OME.cpp:957
std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > >::size_type sizeOfInstrumentList() const
Get size of linked Instrument list.
Definition: OME.cpp:981
ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > & getExperimenterGroup(std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > >::size_type index)
Get ExperimenterGroup.
Definition: OME.cpp:945
void setBinaryOnly(ome::compat::shared_ptr< ome::xml::model::BinaryOnly > &binaryOnly)
Set the BinaryOnly property.
Definition: OME.cpp:1178
std::vector< ome::compat::shared_ptr< ome::xml::model::Project > >::size_type sizeOfProjectList() const
Get size of linked Project list.
Definition: OME.cpp:603
ome::compat::shared_ptr< ome::xml::model::Rights > getRights()
Get the Rights property.
Definition: OME.cpp:582
std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > > & getExperimentList()
Get the Experiment list.
Definition: OME.cpp:717
void removeProject(ome::compat::shared_ptr< ome::xml::model::Project > &project)
Remove Project.
Definition: OME.cpp:646
ome::compat::shared_ptr< std::string > getUUID()
Get the UUID property.
Definition: OME.cpp:540
OME model object.
Definition: OME.h:90
ome::compat::shared_ptr< ome::xml::model::Experiment > & getExperiment(std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > >::size_type index)
Get Experiment.
Definition: OME.cpp:729
void removeExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Remove Experiment.
Definition: OME.cpp:754
ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > structuredAnnotations
StructuredAnnotations property.
Definition: OME.h:118
void setInstrument(std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Set Instrument.
Definition: OME.cpp:1011
DOM Document wrapper.
Definition: Document.h:80
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::compat::shared_ptr< ome::xml::model::Experimenter > & getExperimenter(std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > >::size_type index)
Get Experimenter.
Definition: OME.cpp:891
void addROI(ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Add ROI.
Definition: OME.cpp:1147
std::vector< ome::compat::shared_ptr< ome::xml::model::Project > > & getProjectList()
Get the Project list.
Definition: OME.cpp:609
std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > >::size_type sizeOfScreenList() const
Get size of linked Screen list.
Definition: OME.cpp:819
void removePlate(ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Remove Plate.
Definition: OME.cpp:808
std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > > & getInstrumentList()
Get the Instrument list.
Definition: OME.cpp:987
virtual ~OME()
Destructor.
Definition: OME.cpp:296
std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > >::size_type sizeOfROIList() const
Get size of linked ROI list.
Definition: OME.cpp:1110
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: OME.cpp:525
void setExperimenter(std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Set Experimenter.
Definition: OME.cpp:903
std::vector< ome::compat::shared_ptr< ome::xml::model::Image > > images
Image property (occurs more than once)
Definition: OME.h:116
void addProject(ome::compat::shared_ptr< ome::xml::model::Project > &project)
Add Project.
Definition: OME.cpp:640
std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > > screens
Screen property (occurs more than once)
Definition: OME.h:108
OME()
Default constructor.
Definition: OME.cpp:249
void setDataset(std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Set Dataset.
Definition: OME.cpp:687
void addExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Add ExperimenterGroup.
Definition: OME.cpp:964
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > >::size_type sizeOfExperimenterList() const
Get size of linked Experimenter list.
Definition: OME.cpp:873
std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > > & getScreenList()
Get the Screen list.
Definition: OME.cpp:825
void removeScreen(ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Remove Screen.
Definition: OME.cpp:862
std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > > experimenters
Experimenter property (occurs more than once)
Definition: OME.h:110
std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > >::size_type sizeOfPlateList() const
Get size of linked Plate list.
Definition: OME.cpp:765
std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > >::size_type sizeOfDatasetList() const
Get size of linked Dataset list.
Definition: OME.cpp:657
void addScreen(ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Add Screen.
Definition: OME.cpp:856
ome::compat::shared_ptr< ome::xml::model::BinaryOnly > getBinaryOnly()
Get the BinaryOnly property.
Definition: OME.cpp:1164
ome::compat::shared_ptr< ome::xml::model::Plate > & getPlate(std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > >::size_type index)
Get Plate.
Definition: OME.cpp:783
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: OME.cpp:326
std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > > & getPlateList()
Get the Plate list.
Definition: OME.cpp:771
void setROI(std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > >::size_type index, ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Set ROI.
Definition: OME.cpp:1140
void addExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Add Experiment.
Definition: OME.cpp:748
ome::compat::shared_ptr< ome::xml::model::Dataset > & getDataset(std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > >::size_type index)
Get Dataset.
Definition: OME.cpp:675
void removeDataset(ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Remove Dataset.
Definition: OME.cpp:700
ome::compat::shared_ptr< std::string > getCreator()
Get the Creator property.
Definition: OME.cpp:561
void setScreen(std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Set Screen.
Definition: OME.cpp:849
ome::compat::shared_ptr< std::string > uuid
UUID property.
Definition: OME.h:94
void addImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Add Image.
Definition: OME.cpp:1072
void setCreator(ome::compat::shared_ptr< std::string > &creator)
Set the Creator property.
Definition: OME.cpp:575
ome::compat::shared_ptr< ome::xml::model::Rights > rights
Rights property.
Definition: OME.h:98
void setUUID(ome::compat::shared_ptr< std::string > &uuid)
Set the UUID property.
Definition: OME.cpp:554
std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > > & getDatasetList()
Get the Dataset list.
Definition: OME.cpp:663
std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > >::size_type sizeOfExperimentList() const
Get size of linked Experiment list.
Definition: OME.cpp:711
void setExperiment(std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Set Experiment.
Definition: OME.cpp:741
void addInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Add Instrument.
Definition: OME.cpp:1018
ome::compat::shared_ptr< std::string > creator
Creator property.
Definition: OME.h:96
std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > >::size_type sizeOfExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: OME.cpp:927
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: OME.cpp:317
std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > > datasets
Dataset property (occurs more than once)
Definition: OME.h:102
void setRights(ome::compat::shared_ptr< ome::xml::model::Rights > &rights)
Set the Rights property.
Definition: OME.cpp:596
ome::compat::shared_ptr< ome::xml::model::Project > & getProject(std::vector< ome::compat::shared_ptr< ome::xml::model::Project > >::size_type index)
Get Project.
Definition: OME.cpp:621
std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > > & getExperimenterGroupList()
Get the ExperimenterGroup list.
Definition: OME.cpp:933
std::vector< ome::compat::shared_ptr< ome::xml::model::Image > > & getImageList()
Get the Image list.
Definition: OME.cpp:1041
void setStructuredAnnotations(ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations)
Set the StructuredAnnotations property.
Definition: OME.cpp:1103
std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > > plates
Plate property (occurs more than once)
Definition: OME.h:106
const std::string & elementName() const
Get the element name of this model object.
Definition: OME.cpp:310
std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > > experiments
Experiment property (occurs more than once)
Definition: OME.h:104
std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > > roIs
ROI property (occurs more than once)
Definition: OME.h:120
ome::compat::shared_ptr< ome::xml::model::Image > & getImage(std::vector< ome::compat::shared_ptr< ome::xml::model::Image > >::size_type index)
Get Image.
Definition: OME.cpp:1053
ome::compat::shared_ptr< ome::xml::model::Screen > & getScreen(std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > >::size_type index)
Get Screen.
Definition: OME.cpp:837
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: OME.cpp:1185
void removeExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Remove ExperimenterGroup.
Definition: OME.cpp:970
std::vector< ome::compat::shared_ptr< ome::xml::model::Image > >::size_type sizeOfImageList() const
Get size of linked Image list.
Definition: OME.cpp:1035
ome::compat::shared_ptr< ome::xml::model::BinaryOnly > binaryOnly
BinaryOnly property.
Definition: OME.h:122
void addPlate(ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Add Plate.
Definition: OME.cpp:802
void setImage(std::vector< ome::compat::shared_ptr< ome::xml::model::Image > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Image > &image)
Set Image.
Definition: OME.cpp:1065
std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > > & getExperimenterList()
Get the Experimenter list.
Definition: OME.cpp:879
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: OME.cpp:1192
std::vector< ome::compat::shared_ptr< ome::xml::model::Project > > projects
Project property (occurs more than once)
Definition: OME.h:100
ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: OME.cpp:1089
void removeExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Remove Experimenter.
Definition: OME.cpp:916
Boost.Log compatibility.
void removeInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Remove Instrument.
Definition: OME.cpp:1024
std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > > & getROIList()
Get the ROI list.
Definition: OME.cpp:1116
ome::compat::shared_ptr< ome::xml::model::ROI > & getROI(std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > >::size_type index)
Get ROI.
Definition: OME.cpp:1128
std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > > instruments
Instrument property (occurs more than once)
Definition: OME.h:114
void setPlate(std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Set Plate.
Definition: OME.cpp:795
static ome::compat::shared_ptr< OME > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a OME model object from DOM element.
Definition: OME.cpp:301
void removeImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Remove Image.
Definition: OME.cpp:1078
std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > > experimenterGroups
ExperimenterGroup property (occurs more than once)
Definition: OME.h:112
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: OME.cpp:1421
void removeROI(ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Remove ROI.
Definition: OME.cpp:1153
Xerces-C modern C++ wrapper.
Definition: Base.h:53
void addExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Add Experimenter.
Definition: OME.cpp:910