ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

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/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:
93 class Impl;
95 ome::compat::shared_ptr<Impl> impl;
96
97 public:
99 OME();
100
106 OME (const OME& copy);
107
109 virtual
110 ~OME ();
111
126 static ome::compat::shared_ptr< OME>
127 create(const common::xml::dom::Element& element,
128 ome::xml::model::OMEModel& model);
129
130 // Documented in superclass.
131 const std::string&
132 elementName() const;
133
134 // Documented in superclass.
135 bool
136 validElementName(const std::string& name) const;
137
138
139 // -- OMEModelObject API methods --
140
142 virtual void
143 update(const common::xml::dom::Element& element,
144 ome::xml::model::OMEModel& model);
145
146 public:
147 // -- OME API methods --
148
150 bool
151 link (ome::compat::shared_ptr<Reference>& reference,
152 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
153
159 ome::compat::shared_ptr<std::string>
160 getUUID ();
161
167 const ome::compat::shared_ptr<std::string>
168 getUUID () const;
169
175 void
176 setUUID (ome::compat::shared_ptr<std::string>& uuid);
177
183 ome::compat::shared_ptr<std::string>
184 getCreator ();
185
191 const ome::compat::shared_ptr<std::string>
192 getCreator () const;
193
199 void
200 setCreator (ome::compat::shared_ptr<std::string>& creator);
201
207 ome::compat::shared_ptr<ome::xml::model::Rights>
208 getRights ();
209
215 const ome::compat::shared_ptr<ome::xml::model::Rights>
216 getRights () const;
217
223 void
224 setRights (ome::compat::shared_ptr<ome::xml::model::Rights>& rights);
225
231 std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type
232 sizeOfProjectList () const;
233
240 std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
241 getProjectList ();
242
249 const std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >&
250 getProjectList () const;
251
259 ome::compat::shared_ptr<ome::xml::model::Project>&
260 getProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index);
261
269 const ome::compat::shared_ptr<ome::xml::model::Project>&
270 getProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index) const;
271
279 void
280 setProject (std::vector<ome::compat::shared_ptr<ome::xml::model::Project> >::size_type index,
281 ome::compat::shared_ptr<ome::xml::model::Project>& project);
282
291 void
292 addProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);
293
303 void
304 removeProject (ome::compat::shared_ptr<ome::xml::model::Project>& project);
305
311 std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type
312 sizeOfDatasetList () const;
313
320 std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
321 getDatasetList ();
322
329 const std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >&
330 getDatasetList () const;
331
339 ome::compat::shared_ptr<ome::xml::model::Dataset>&
340 getDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index);
341
349 const ome::compat::shared_ptr<ome::xml::model::Dataset>&
350 getDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index) const;
351
359 void
360 setDataset (std::vector<ome::compat::shared_ptr<ome::xml::model::Dataset> >::size_type index,
361 ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
362
371 void
372 addDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
373
383 void
384 removeDataset (ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
385
391 std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type
392 sizeOfExperimentList () const;
393
400 std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
401 getExperimentList ();
402
409 const std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >&
410 getExperimentList () const;
411
419 ome::compat::shared_ptr<ome::xml::model::Experiment>&
420 getExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index);
421
429 const ome::compat::shared_ptr<ome::xml::model::Experiment>&
430 getExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index) const;
431
439 void
440 setExperiment (std::vector<ome::compat::shared_ptr<ome::xml::model::Experiment> >::size_type index,
441 ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
442
451 void
452 addExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
453
463 void
464 removeExperiment (ome::compat::shared_ptr<ome::xml::model::Experiment>& experiment);
465
471 std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type
472 sizeOfPlateList () const;
473
480 std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
481 getPlateList ();
482
489 const std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >&
490 getPlateList () const;
491
499 ome::compat::shared_ptr<ome::xml::model::Plate>&
500 getPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index);
501
509 const ome::compat::shared_ptr<ome::xml::model::Plate>&
510 getPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index) const;
511
519 void
520 setPlate (std::vector<ome::compat::shared_ptr<ome::xml::model::Plate> >::size_type index,
521 ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
522
531 void
532 addPlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
533
543 void
544 removePlate (ome::compat::shared_ptr<ome::xml::model::Plate>& plate);
545
551 std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type
552 sizeOfScreenList () const;
553
560 std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
561 getScreenList ();
562
569 const std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >&
570 getScreenList () const;
571
579 ome::compat::shared_ptr<ome::xml::model::Screen>&
580 getScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index);
581
589 const ome::compat::shared_ptr<ome::xml::model::Screen>&
590 getScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index) const;
591
599 void
600 setScreen (std::vector<ome::compat::shared_ptr<ome::xml::model::Screen> >::size_type index,
601 ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
602
611 void
612 addScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
613
623 void
624 removeScreen (ome::compat::shared_ptr<ome::xml::model::Screen>& screen);
625
631 std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type
632 sizeOfExperimenterList () const;
633
640 std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
641 getExperimenterList ();
642
649 const std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >&
650 getExperimenterList () const;
651
659 ome::compat::shared_ptr<ome::xml::model::Experimenter>&
660 getExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index);
661
669 const ome::compat::shared_ptr<ome::xml::model::Experimenter>&
670 getExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index) const;
671
679 void
680 setExperimenter (std::vector<ome::compat::shared_ptr<ome::xml::model::Experimenter> >::size_type index,
681 ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
682
691 void
692 addExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
693
703 void
704 removeExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
705
711 std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type
712 sizeOfExperimenterGroupList () const;
713
720 std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
721 getExperimenterGroupList ();
722
729 const std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >&
730 getExperimenterGroupList () const;
731
739 ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>&
740 getExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index);
741
749 const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>&
750 getExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index) const;
751
759 void
760 setExperimenterGroup (std::vector<ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup> >::size_type index,
761 ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
762
771 void
772 addExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
773
783 void
784 removeExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
785
791 std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type
792 sizeOfInstrumentList () const;
793
800 std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
801 getInstrumentList ();
802
809 const std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >&
810 getInstrumentList () const;
811
819 ome::compat::shared_ptr<ome::xml::model::Instrument>&
820 getInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index);
821
829 const ome::compat::shared_ptr<ome::xml::model::Instrument>&
830 getInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index) const;
831
839 void
840 setInstrument (std::vector<ome::compat::shared_ptr<ome::xml::model::Instrument> >::size_type index,
841 ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
842
851 void
852 addInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
853
863 void
864 removeInstrument (ome::compat::shared_ptr<ome::xml::model::Instrument>& instrument);
865
871 std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type
872 sizeOfImageList () const;
873
880 std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
881 getImageList ();
882
889 const std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >&
890 getImageList () const;
891
899 ome::compat::shared_ptr<ome::xml::model::Image>&
900 getImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index);
901
909 const ome::compat::shared_ptr<ome::xml::model::Image>&
910 getImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index) const;
911
919 void
920 setImage (std::vector<ome::compat::shared_ptr<ome::xml::model::Image> >::size_type index,
921 ome::compat::shared_ptr<ome::xml::model::Image>& image);
922
931 void
932 addImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
933
943 void
944 removeImage (ome::compat::shared_ptr<ome::xml::model::Image>& image);
945
951 ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
952 getStructuredAnnotations ();
953
959 const ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>
960 getStructuredAnnotations () const;
961
967 void
968 setStructuredAnnotations (ome::compat::shared_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations);
969
975 std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type
976 sizeOfROIList () const;
977
984 std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
985 getROIList ();
986
993 const std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >&
994 getROIList () const;
995
1003 ome::compat::shared_ptr<ome::xml::model::ROI>&
1004 getROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index);
1005
1013 const ome::compat::shared_ptr<ome::xml::model::ROI>&
1014 getROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index) const;
1015
1023 void
1024 setROI (std::vector<ome::compat::shared_ptr<ome::xml::model::ROI> >::size_type index,
1025 ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1026
1035 void
1036 addROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1037
1047 void
1048 removeROI (ome::compat::shared_ptr<ome::xml::model::ROI>& roi);
1049
1055 ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
1056 getBinaryOnly ();
1057
1063 const ome::compat::shared_ptr<ome::xml::model::BinaryOnly>
1064 getBinaryOnly () const;
1065
1071 void
1072 setBinaryOnly (ome::compat::shared_ptr<ome::xml::model::BinaryOnly>& binaryOnly);
1073
1074
1076 virtual common::xml::dom::Element
1077 asXMLElement (common::xml::dom::Document& document) const;
1078
1079
1080 protected:
1081 // Documented in base class.
1082 virtual common::xml::dom::Element
1083 asXMLElementInternal (common::xml::dom::Document& document,
1084 common::xml::dom::Element& element) const;
1085
1086 public:
1087 // Documented in superclass.
1088 const std::string&
1089 getXMLNamespace() const;
1090 };
1091
1092 }
1093 }
1094 }
1095
1096 #endif // OME_XML_MODEL_OME_H
1097
1098 /*
1099 * Local Variables:
1100 * mode:C++
1101 * End:
1102 */
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:1042
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:676
ome::xml::model::OME::addDataset
void addDataset(ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Add Dataset.
Definition: OME.cpp:737
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:1000
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:1024
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:988
ome::xml::model::OME::setBinaryOnly
void setBinaryOnly(ome::compat::shared_ptr< ome::xml::model::BinaryOnly > &binaryOnly)
Set the BinaryOnly property.
Definition: OME.cpp:1221
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:646
ome::xml::model::OME::getRights
ome::compat::shared_ptr< ome::xml::model::Rights > getRights()
Get the Rights property.
Definition: OME.cpp:625
ome::xml::model::OME::getExperimentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Experiment > > & getExperimentList()
Get the Experiment list.
Definition: OME.cpp:760
ome::xml::model::OME::Impl
Private implementation details of OME model object.
Definition: OME.cpp:182
ome::xml::model::OME::removeProject
void removeProject(ome::compat::shared_ptr< ome::xml::model::Project > &project)
Remove Project.
Definition: OME.cpp:689
ome::xml::model::OME::getUUID
ome::compat::shared_ptr< std::string > getUUID()
Get the UUID property.
Definition: OME.cpp:583
ome::xml::model::OME
OME model object.
Definition: OME.h:90
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:772
ome::xml::model::OME::removeExperiment
void removeExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Remove Experiment.
Definition: OME.cpp:797
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:1054
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:934
ome::xml::model::OME::addROI
void addROI(ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Add ROI.
Definition: OME.cpp:1190
ome::xml::model::OME::getProjectList
std::vector< ome::compat::shared_ptr< ome::xml::model::Project > > & getProjectList()
Get the Project list.
Definition: OME.cpp:652
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:862
ome::xml::model::OME::removePlate
void removePlate(ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Remove Plate.
Definition: OME.cpp:851
ome::xml::model::OME::getInstrumentList
std::vector< ome::compat::shared_ptr< ome::xml::model::Instrument > > & getInstrumentList()
Get the Instrument list.
Definition: OME.cpp:1030
ome::xml::model::OME::~OME
virtual ~OME()
Destructor.
Definition: OME.cpp:339
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:1153
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:568
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:946
ome::xml::model::OME::addProject
void addProject(ome::compat::shared_ptr< ome::xml::model::Project > &project)
Add Project.
Definition: OME.cpp:683
ome::xml::model::OME::OME
OME()
Default constructor.
Definition: OME.cpp:320
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:730
ome::xml::model::OME::addExperimenterGroup
void addExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Add ExperimenterGroup.
Definition: OME.cpp:1007
ome
Open Microscopy Environment C++ implementation.
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:916
ome::xml::model::OME::getScreenList
std::vector< ome::compat::shared_ptr< ome::xml::model::Screen > > & getScreenList()
Get the Screen list.
Definition: OME.cpp:868
ome::xml::model::OME::removeScreen
void removeScreen(ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Remove Screen.
Definition: OME.cpp:905
ome::xml::model::OME::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: OME.h:93
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:808
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:700
ome::xml::model::OME::addScreen
void addScreen(ome::compat::shared_ptr< ome::xml::model::Screen > &screen)
Add Screen.
Definition: OME.cpp:899
ome::xml::model::OME::getBinaryOnly
ome::compat::shared_ptr< ome::xml::model::BinaryOnly > getBinaryOnly()
Get the BinaryOnly property.
Definition: OME.cpp:1207
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:826
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:369
ome::xml::model::OME::getPlateList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plate > > & getPlateList()
Get the Plate list.
Definition: OME.cpp:814
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:1183
ome::xml::model::OME::addExperiment
void addExperiment(ome::compat::shared_ptr< ome::xml::model::Experiment > &experiment)
Add Experiment.
Definition: OME.cpp:791
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:718
ome::xml::model::OME::removeDataset
void removeDataset(ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Remove Dataset.
Definition: OME.cpp:743
ome::xml::model::OME::getCreator
ome::compat::shared_ptr< std::string > getCreator()
Get the Creator property.
Definition: OME.cpp:604
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:892
ome::xml::model::OME::addImage
void addImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Add Image.
Definition: OME.cpp:1115
ome::xml::model::OME::setCreator
void setCreator(ome::compat::shared_ptr< std::string > &creator)
Set the Creator property.
Definition: OME.cpp:618
ome::xml::model::OME::setUUID
void setUUID(ome::compat::shared_ptr< std::string > &uuid)
Set the UUID property.
Definition: OME.cpp:597
ome::xml::model::OME::getDatasetList
std::vector< ome::compat::shared_ptr< ome::xml::model::Dataset > > & getDatasetList()
Get the Dataset list.
Definition: OME.cpp:706
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:754
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:784
ome::xml::model::OME::addInstrument
void addInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Add Instrument.
Definition: OME.cpp:1061
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:970
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:360
ome::xml::model::OME::setRights
void setRights(ome::compat::shared_ptr< ome::xml::model::Rights > &rights)
Set the Rights property.
Definition: OME.cpp:639
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:664
ome::xml::model::OME::getExperimenterGroupList
std::vector< ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > > & getExperimenterGroupList()
Get the ExperimenterGroup list.
Definition: OME.cpp:976
ome::xml::model::OME::getImageList
std::vector< ome::compat::shared_ptr< ome::xml::model::Image > > & getImageList()
Get the Image list.
Definition: OME.cpp:1084
ome::xml::model::OME::setStructuredAnnotations
void setStructuredAnnotations(ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations)
Set the StructuredAnnotations property.
Definition: OME.cpp:1146
ome::xml::model::OME::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: OME.cpp:353
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:1096
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:880
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:1228
ome::xml::model::OME::removeExperimenterGroup
void removeExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Remove ExperimenterGroup.
Definition: OME.cpp:1013
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:1078
ome::xml::model::OME::addPlate
void addPlate(ome::compat::shared_ptr< ome::xml::model::Plate > &plate)
Add Plate.
Definition: OME.cpp:845
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:1108
ome::xml::model::OME::getExperimenterList
std::vector< ome::compat::shared_ptr< ome::xml::model::Experimenter > > & getExperimenterList()
Get the Experimenter list.
Definition: OME.cpp:922
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:1235
ome::xml::model::OME::getStructuredAnnotations
ome::compat::shared_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: OME.cpp:1132
ome::xml::model::OME::removeExperimenter
void removeExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Remove Experimenter.
Definition: OME.cpp:959
log.h
ome::xml::model::OME::removeInstrument
void removeInstrument(ome::compat::shared_ptr< ome::xml::model::Instrument > &instrument)
Remove Instrument.
Definition: OME.cpp:1067
ome::xml::model::OME::getROIList
std::vector< ome::compat::shared_ptr< ome::xml::model::ROI > > & getROIList()
Get the ROI list.
Definition: OME.cpp:1159
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:1171
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:838
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:344
ome::xml::model::OME::removeImage
void removeImage(ome::compat::shared_ptr< ome::xml::model::Image > &image)
Remove Image.
Definition: OME.cpp:1121
ome::xml::model::OME::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: OME.cpp:1464
ome::xml::model::OME::removeROI
void removeROI(ome::compat::shared_ptr< ome::xml::model::ROI > &roi)
Remove ROI.
Definition: OME.cpp:1196
ome::xml::model::OME::addExperimenter
void addExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Add Experimenter.
Definition: OME.cpp:953