ome-xml 5.2.3

OME.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_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/primitives/Quantity.h>
63
64 #include <ome/xml/model/BinaryOnly.h>
65 #include <ome/xml/model/Rights.h>
66 #include <ome/xml/model/StructuredAnnotations.h>
67 #include <ome/xml/model/detail/OMEModelObject.h>
68
69 namespace ome
70 {
71 namespace xml
72 {
73 namespace model
74 {
75
76 // Forward declarations.
77 class Dataset;
78 class Experiment;
79 class Experimenter;
80 class ExperimenterGroup;
81 class Folder;
82 class Image;
83 class Instrument;
84 class OMEModel;
85 class Plate;
86 class Project;
87 class ROI;
88 class Screen;
89
93 class OME : public detail::OMEModelObject
94 {
95 private:
96 class Impl;
98 ome::compat::shared_ptr<Impl> impl;
99
100 public:
102 OME();
103
109 OME (const OME& copy);
110
112 virtual
113 ~OME ();
114
129 static ome::compat::shared_ptr< OME>
130 create(const common::xml::dom::Element& element,
131 ome::xml::model::OMEModel& model);
132
133 // Documented in superclass.
134 const std::string&
135 elementName() const;
136
137 // Documented in superclass.
138 bool
139 validElementName(const std::string& name) const;
140
141 private:
143 OME&
144 operator= (const OME&);
145
146 public:
147 // -- OMEModelObject API methods --
148
150 virtual void
151 update(const common::xml::dom::Element& element,
152 ome::xml::model::OMEModel& model);
153
154 public:
155 // -- OME API methods --
156
158 bool
159 link (ome::compat::shared_ptr<Reference>& reference,
160 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
161
167 ome::compat::shared_ptr<std::string>
168 getUUID ();
169
175 const ome::compat::shared_ptr<std::string>
176 getUUID () const;
177
183 void
184 setUUID (ome::compat::shared_ptr<std::string>& uuid);
185
191 ome::compat::shared_ptr<std::string>
192 getCreator ();
193
199 const ome::compat::shared_ptr<std::string>
200 getCreator () const;
201
207 void
208 setCreator (ome::compat::shared_ptr<std::string>& creator);
209
215 ome::compat::shared_ptr<ome::xml::model::Rights>
216 getRights ();
217
223 const ome::compat::shared_ptr<ome::xml::model::Rights>
224 getRights () const;
225
231 void
232 setRights (ome::compat::shared_ptr<ome::xml::model::Rights>& rights);
233
239 std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type
240 sizeOfProjectList () const;
241
248 std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
249 getProjectList ();
250
257 const std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
258 getProjectList () const;
259
267 ome::compat::shared_ptr<ome::xml::model::Project>&
268 getProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index);
269
277 const ome::compat::shared_ptr<ome::xml::model::Project>&
278 getProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index) const;
279
287 void
288 setProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index,
289 ome::compat::shared_ptr<ome::xml::model::Project>& project);
290
299 void
300 addProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);
301
311 void
312 removeProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);
313
319 std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type
320 sizeOfDatasetList () const;
321
328 std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
329 getDatasetList ();
330
337 const std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
338 getDatasetList () const;
339
347 ome::compat::shared_ptr<ome::xml::model::Dataset>&
348 getDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index);
349
357 const ome::compat::shared_ptr<ome::xml::model::Dataset>&
358 getDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index) const;
359
367 void
368 setDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index,
369 ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
370
379 void
380 addDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
381
391 void
392 removeDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
393
399 std::vector<ome::compat::shared_ptr<ome::xml::model::Folder> >::size_type
400 sizeOfFolderList () const;
401
408 std::vector<ome::compat::shared_ptr<ome::xml::model::Folder> >&
409 getFolderList ();
410
417 const std::vector<ome::compat::shared_ptr<ome::xml::model::Folder> >&
418 getFolderList () const;
419
427 ome::compat::shared_ptr<ome::xml::model::Folder>&
428 getFolder (std::vector<ome::compat::shared_ptr<ome::xml::model::Folder> >::size_type index);
429
437 const ome::compat::shared_ptr<ome::xml::model::Folder>&
438 getFolder (std::vector<ome::compat::shared_ptr<ome::xml::model::Folder> >::size_type index) const;
439
447 void
448 setFolder (std::vector<ome::compat::shared_ptr<ome::xml::model::Folder> >::size_type index,
449 ome::compat::shared_ptr<ome::xml::model::Folder>& folder);
450
459 void
460 addFolder (ome::compat::shared_ptr<ome::xml::model::Folder>& folder);
461
471 void
472 removeFolder (ome::compat::shared_ptr<ome::xml::model::Folder>& folder);
473
479 std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type
480 sizeOfExperimentList () const;
481
488 std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
489 getExperimentList ();
490
497 const std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
498 getExperimentList () const;
499
507 ome::compat::shared_ptr<ome::xml::model::Experiment>&
508 getExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index);
509
517 const ome::compat::shared_ptr<ome::xml::model::Experiment>&
518 getExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index) const;
519
527 void
528 setExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index,
529 ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
530
539 void
540 addExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
541
551 void
552 removeExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
553
559 std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type
560 sizeOfPlateList () const;
561
568 std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
569 getPlateList ();
570
577 const std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
578 getPlateList () const;
579
587 ome::compat::shared_ptr<ome::xml::model::Plate>&
588 getPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index);
589
597 const ome::compat::shared_ptr<ome::xml::model::Plate>&
598 getPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index) const;
599
607 void
608 setPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index,
609 ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
610
619 void
620 addPlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
621
631 void
632 removePlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
633
639 std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type
640 sizeOfScreenList () const;
641
648 std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
649 getScreenList ();
650
657 const std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
658 getScreenList () const;
659
667 ome::compat::shared_ptr<ome::xml::model::Screen>&
668 getScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index);
669
677 const ome::compat::shared_ptr<ome::xml::model::Screen>&
678 getScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index) const;
679
687 void
688 setScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index,
689 ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
690
699 void
700 addScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
701
711 void
712 removeScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
713
719 std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type
720 sizeOfExperimenterList () const;
721
728 std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
729 getExperimenterList ();
730
737 const std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
738 getExperimenterList () const;
739
747 ome::compat::shared_ptr<ome::xml::model::Experimenter>&
748 getExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index);
749
757 const ome::compat::shared_ptr<ome::xml::model::Experimenter>&
758 getExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index) const;
759
767 void
768 setExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index,
769 ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
770
779 void
780 addExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
781
791 void
792 removeExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
793
799 std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type
800 sizeOfExperimenterGroupList () const;
801
808 std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
809 getExperimenterGroupList ();
810
817 const std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
818 getExperimenterGroupList () const;
819
827 ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>&
828 getExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index);
829
837 const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>&
838 getExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index) const;
839
847 void
848 setExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index,
849 ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
850
859 void
860 addExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
861
871 void
872 removeExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
873
879 std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type
880 sizeOfInstrumentList () const;
881
888 std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
889 getInstrumentList ();
890
897 const std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
898 getInstrumentList () const;
899
907 ome::compat::shared_ptr<ome::xml::model::Instrument>&
908 getInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index);
909
917 const ome::compat::shared_ptr<ome::xml::model::Instrument>&
918 getInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index) const;
919
927 void
928 setInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index,
929 ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
930
939 void
940 addInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
941
951 void
952 removeInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
953
959 std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type
960 sizeOfImageList () const;
961
968 std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
969 getImageList ();
970
977 const std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
978 getImageList () const;
979
987 ome::compat::shared_ptr<ome::xml::model::Image>&
988 getImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index);
989
997 const ome::compat::shared_ptr<ome::xml::model::Image>&
998 getImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index) const;
999
1007 void
1008 setImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index,
1009 ome::compat::shared_ptr<ome::xml::model::Image>& image);
1010
1019 void
1020 addImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
1021
1031 void
1032 removeImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
1033
1039 ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
1040 getStructuredAnnotations ();
1041
1047 const ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
1048 getStructuredAnnotations () const;
1049
1055 void
1056 setStructuredAnnotations (ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations);
1057
1063 std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type
1064 sizeOfROIList () const;
1065
1072 std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
1073 getROIList ();
1074
1081 const std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
1082 getROIList () const;
1083
1091 ome::compat::shared_ptr<ome::xml::model::ROI>&
1092 getROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index);
1093
1101 const ome::compat::shared_ptr<ome::xml::model::ROI>&
1102 getROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index) const;
1103
1111 void
1112 setROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index,
1113 ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1114
1123 void
1124 addROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1125
1135 void
1136 removeROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1137
1143 ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
1144 getBinaryOnly ();
1145
1151 const ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
1152 getBinaryOnly () const;
1153
1159 void
1160 setBinaryOnly (ome::compat::shared_ptr<ome::xml::model::BinaryOnly>& binaryOnly);
1161
1163 virtual common::xml::dom::Element
1164 asXMLElement (common::xml::dom::Document& document) const;
1165
1166
1167 protected:
1168 // Documented in base class.
1169 virtual common::xml::dom::Element
1170 asXMLElementInternal (common::xml::dom::Document& document,
1171 common::xml::dom::Element& element) const;
1172
1173 public:
1174 // Documented in superclass.
1175 const std::string&
1176 getXMLNamespace() const;
1177 };
1178
1179 }
1180 }
1181 }
1182
1183 #endif // OME_XML_MODEL_OME_H
1184
1185 /*
1186 * Local Variables:
1187 * mode:C++
1188 * End:
1189 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::OME::getInstrument
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:1113
ome::xml::model::OME::setProject
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:693
ome::xml::model::OME::addDataset
void addDataset(ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Add Dataset.
Definition: OME.cpp:754
ome::xml::model::OME::setExperimenterGroup
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:1071
ome::xml::model::OME::sizeOfDatasetList
std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > >::size_type sizeOfDatasetList() const
Get size of linked Dataset list.
Definition: OME.cpp:717
ome::xml::model::OME::getExperimenterGroup
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:1059
ome::xml::model::OME::setBinaryOnly
void setBinaryOnly(ome::compat::shared_ptr< ome::xml::model::BinaryOnly > &binaryOnly)
Set the BinaryOnly property.
Definition: OME.cpp:1292
ome::xml::model::OME::getRights
ome::compat::shared_ptr< ome::xml::model::Rights > getRights()
Get the Rights property.
Definition: OME.cpp:642
ome::xml::model::OME::getExperimentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > > & getExperimentList()
Get the Experiment list.
Definition: OME.cpp:831
ome::xml::model::OME::setFolder
void setFolder(std::vector< ome::compat::shared_ptr< ome::xml::model::Folder > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Folder > &folder)
Set Folder.
Definition: OME.cpp:801
ome::xml::model::OME::Impl
Private implementation details of OME model object.
Definition: OME.cpp:185
ome::xml::model::OME::asXMLElement
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:1298
ome::xml::model::OME::removeProject
void removeProject(ome::compat::shared_ptr< ome::xml::model::Project > &project)
Remove Project.
Definition: OME.cpp:706
ome::xml::model::OME::getUUID
ome::compat::shared_ptr< std::string > getUUID()
Get the UUID property.
Definition: OME.cpp:600
ome::xml::model::OME::sizeOfInstrumentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > >::size_type sizeOfInstrumentList() const
Get size of linked Instrument list.
Definition: OME.cpp:1095
ome::xml::model::OME
OME model object.
Definition: OME.h:93
ome::xml::model::OME::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: OME.cpp:358
ome::xml::model::OME::getExperiment
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:843
ome::xml::model::OME::removeExperiment
void removeExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Remove Experiment.
Definition: OME.cpp:868
ome::xml::model::OME::setInstrument
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:1125
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::OME::getExperimenter
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:1005
ome::xml::model::OME::addROI
void addROI(ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Add ROI.
Definition: OME.cpp:1261
ome::xml::model::OME::getProjectList
std::vector< ome::compat::shared_ptr< ome::xml::model::Project > > & getProjectList()
Get the Project list.
Definition: OME.cpp:669
ome::xml::model::OME::removePlate
void removePlate(ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Remove Plate.
Definition: OME.cpp:922
ome::xml::model::OME::sizeOfROIList
std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > >::size_type sizeOfROIList() const
Get size of linked ROI list.
Definition: OME.cpp:1224
ome::xml::model::OME::getInstrumentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > > & getInstrumentList()
Get the Instrument list.
Definition: OME.cpp:1101
ome::xml::model::OME::~OME
virtual ~OME()
Destructor.
Definition: OME.cpp:344
ome::xml::model::OME::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: OME.cpp:585
ome::xml::model::OME::setExperimenter
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:1017
ome::xml::model::OME::sizeOfExperimenterGroupList
std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > >::size_type sizeOfExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: OME.cpp:1041
ome::xml::model::OME::addProject
void addProject(ome::compat::shared_ptr< ome::xml::model::Project > &project)
Add Project.
Definition: OME.cpp:700
ome::xml::model::OME::OME
OME()
Default constructor.
Definition: OME.cpp:329
ome::xml::model::OME::setDataset
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:747
ome::xml::model::OME::sizeOfProjectList
std::vector< ome::compat::shared_ptr< ome::xml::model::Project > >::size_type sizeOfProjectList() const
Get size of linked Project list.
Definition: OME.cpp:663
ome::xml::model::OME::addExperimenterGroup
void addExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Add ExperimenterGroup.
Definition: OME.cpp:1078
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::OME::getScreenList
std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > > & getScreenList()
Get the Screen list.
Definition: OME.cpp:939
ome::xml::model::OME::removeScreen
void removeScreen(ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Remove Screen.
Definition: OME.cpp:976
ome::xml::model::OME::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: OME.h:96
ome::xml::model::OME::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: OME.cpp:1305
ome::xml::model::OME::addScreen
void addScreen(ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Add Screen.
Definition: OME.cpp:970
ome::xml::model::OME::getBinaryOnly
ome::compat::shared_ptr< ome::xml::model::BinaryOnly > getBinaryOnly()
Get the BinaryOnly property.
Definition: OME.cpp:1278
ome::xml::model::OME::getPlate
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:897
ome::xml::model::OME::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: OME.cpp:373
ome::xml::model::OME::getPlateList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > > & getPlateList()
Get the Plate list.
Definition: OME.cpp:885
ome::xml::model::OME::setROI
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:1254
ome::xml::model::OME::getFolderList
std::vector< ome::compat::shared_ptr< ome::xml::model::Folder > > & getFolderList()
Get the Folder list.
Definition: OME.cpp:777
ome::xml::model::OME::addExperiment
void addExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Add Experiment.
Definition: OME.cpp:862
ome::xml::model::OME::getDataset
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:735
ome::xml::model::OME::removeDataset
void removeDataset(ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Remove Dataset.
Definition: OME.cpp:760
ome::xml::model::OME::getCreator
ome::compat::shared_ptr< std::string > getCreator()
Get the Creator property.
Definition: OME.cpp:621
ome::xml::model::OME::setScreen
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:963
ome::xml::model::OME::addImage
void addImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Add Image.
Definition: OME.cpp:1186
ome::xml::model::OME::setCreator
void setCreator(ome::compat::shared_ptr< std::string > &creator)
Set the Creator property.
Definition: OME.cpp:635
ome::xml::model::OME::sizeOfImageList
std::vector< ome::compat::shared_ptr< ome::xml::model::Image > >::size_type sizeOfImageList() const
Get size of linked Image list.
Definition: OME.cpp:1149
ome::xml::model::OME::setUUID
void setUUID(ome::compat::shared_ptr< std::string > &uuid)
Set the UUID property.
Definition: OME.cpp:614
ome::xml::model::OME::getDatasetList
std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > > & getDatasetList()
Get the Dataset list.
Definition: OME.cpp:723
ome::xml::model::OME::setExperiment
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:855
ome::xml::model::OME::addInstrument
void addInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Add Instrument.
Definition: OME.cpp:1132
ome::xml::model::OME::setRights
void setRights(ome::compat::shared_ptr< ome::xml::model::Rights > &rights)
Set the Rights property.
Definition: OME.cpp:656
ome::xml::model::OME::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: OME.cpp:1550
ome::xml::model::OME::sizeOfFolderList
std::vector< ome::compat::shared_ptr< ome::xml::model::Folder > >::size_type sizeOfFolderList() const
Get size of linked Folder list.
Definition: OME.cpp:771
ome::xml::model::OME::getProject
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:681
ome::xml::model::OME::getExperimenterGroupList
std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > > & getExperimenterGroupList()
Get the ExperimenterGroup list.
Definition: OME.cpp:1047
ome::xml::model::OME::getImageList
std::vector< ome::compat::shared_ptr< ome::xml::model::Image > > & getImageList()
Get the Image list.
Definition: OME.cpp:1155
ome::xml::model::OME::setStructuredAnnotations
void setStructuredAnnotations(ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations)
Set the StructuredAnnotations property.
Definition: OME.cpp:1217
ome::xml::model::OME::getImage
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:1167
ome::xml::model::OME::getScreen
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:951
ome::xml::model::OME::removeFolder
void removeFolder(ome::compat::shared_ptr< ome::xml::model::Folder > &folder)
Remove Folder.
Definition: OME.cpp:814
ome::xml::model::OME::removeExperimenterGroup
void removeExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Remove ExperimenterGroup.
Definition: OME.cpp:1084
ome::xml::model::OME::sizeOfExperimentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > >::size_type sizeOfExperimentList() const
Get size of linked Experiment list.
Definition: OME.cpp:825
ome::xml::model::OME::addFolder
void addFolder(ome::compat::shared_ptr< ome::xml::model::Folder > &folder)
Add Folder.
Definition: OME.cpp:808
ome::xml::model::OME::addPlate
void addPlate(ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Add Plate.
Definition: OME.cpp:916
ome::xml::model::OME::setImage
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:1179
ome::xml::model::OME::getExperimenterList
std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > > & getExperimenterList()
Get the Experimenter list.
Definition: OME.cpp:993
ome::xml::model::OME::getStructuredAnnotations
ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: OME.cpp:1203
ome::xml::model::OME::operator=
OME & operator=(const OME &)
Assignment operator (deleted).
ome::xml::model::OME::removeExperimenter
void removeExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Remove Experimenter.
Definition: OME.cpp:1030
ome::xml::model::OME::removeInstrument
void removeInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Remove Instrument.
Definition: OME.cpp:1138
ome::xml::model::OME::sizeOfPlateList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > >::size_type sizeOfPlateList() const
Get size of linked Plate list.
Definition: OME.cpp:879
ome::xml::model::OME::sizeOfScreenList
std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > >::size_type sizeOfScreenList() const
Get size of linked Screen list.
Definition: OME.cpp:933
ome::xml::model::OME::getROIList
std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > > & getROIList()
Get the ROI list.
Definition: OME.cpp:1230
ome::xml::model::OME::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: OME.cpp:365
ome::xml::model::OME::getROI
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:1242
log.h
ome::xml::model::OME::sizeOfExperimenterList
std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > >::size_type sizeOfExperimenterList() const
Get size of linked Experimenter list.
Definition: OME.cpp:987
ome::xml::model::OME::setPlate
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:909
ome::xml::model::OME::create
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:349
ome::xml::model::OME::getFolder
ome::compat::shared_ptr< ome::xml::model::Folder > & getFolder(std::vector< ome::compat::shared_ptr< ome::xml::model::Folder > >::size_type index)
Get Folder.
Definition: OME.cpp:789
ome::xml::model::OME::removeImage
void removeImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Remove Image.
Definition: OME.cpp:1192
ome::xml::model::OME::removeROI
void removeROI(ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Remove ROI.
Definition: OME.cpp:1267
ome::xml::model::OME::addExperimenter
void addExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Add Experimenter.
Definition: OME.cpp:1024