ome-xml  5.6.0
Annotation.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_ANNOTATION_H
47 #define OME_XML_MODEL_ANNOTATION_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 
61 #include <ome/xml/model/primitives/Quantity.h>
62 
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class Channel;
74  class Dataset;
75  class Detector;
76  class Dichroic;
77  class Experimenter;
78  class ExperimenterGroup;
79  class Filter;
80  class Folder;
81  class Image;
82  class Instrument;
83  class LightPath;
84  class LightSource;
85  class OMEModel;
86  class Objective;
87  class Plane;
88  class Plate;
89  class PlateAcquisition;
90  class Project;
91  class ROI;
92  class Reagent;
93  class Screen;
94  class Shape;
95  class Well;
96 
100  class Annotation : public detail::OMEModelObject
101  {
102  private:
103  class Impl;
105  std::shared_ptr<Impl> impl;
106 
107  public:
109  Annotation();
110 
116  Annotation (const Annotation& copy);
117 
119  virtual
120  ~Annotation ();
121 
122  // Documented in superclass.
123  bool
124  validElementName(const std::string& name) const;
125 
127  Annotation&
128  operator= (const Annotation&) = delete;
130 
131  // -- OMEModelObject API methods --
132 
134  virtual void
135  update(const common::xml::dom::Element& element,
136  ome::xml::model::OMEModel& model);
137 
138  public:
139  // -- Annotation API methods --
140 
142  bool
143  link (std::shared_ptr<Reference>& reference,
144  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
145 
151  std::shared_ptr<std::string>
152  getNamespace ();
153 
159  const std::shared_ptr<std::string>
160  getNamespace () const;
161 
167  void
168  setNamespace (std::shared_ptr<std::string>& namespace_);
169 
175  const std::string&
176  getID () const;
177 
183  void
184  setID (const std::string& id);
185 
191  std::shared_ptr<std::string>
192  getAnnotator ();
193 
199  const std::shared_ptr<std::string>
200  getAnnotator () const;
201 
207  void
208  setAnnotator (std::shared_ptr<std::string>& annotator);
209 
215  std::shared_ptr<std::string>
216  getDescription ();
217 
223  const std::shared_ptr<std::string>
224  getDescription () const;
225 
231  void
232  setDescription (std::shared_ptr<std::string>& description);
233 
239  OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type::size_type
240  sizeOfLinkedAnnotationList () const;
241 
247  OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type
248  getLinkedAnnotationList () const;
249 
257  const std::weak_ptr<ome::xml::model::Annotation>&
258  getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type::size_type index) const;
259 
270  const std::weak_ptr<ome::xml::model::Annotation>&
271  setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type::size_type index,
272  const std::shared_ptr<ome::xml::model::Annotation>& annotation);
273 
284  bool
285  linkAnnotation (const std::shared_ptr<ome::xml::model::Annotation>& annotation);
286 
302  bool
303  unlinkAnnotation (const std::shared_ptr<ome::xml::model::Annotation>& annotation);
304 
310  OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type::size_type
311  sizeOfLinkedImageList () const;
312 
318  OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type
319  getLinkedImageList () const;
320 
328  const std::weak_ptr<ome::xml::model::Image>&
329  getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type::size_type index) const;
330 
341  const std::weak_ptr<ome::xml::model::Image>&
342  setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type::size_type index,
343  const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
344 
355  bool
356  linkImage (const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
357 
373  bool
374  unlinkImage (const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
375 
381  OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type::size_type
382  sizeOfLinkedPlaneList () const;
383 
389  OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type
390  getLinkedPlaneList () const;
391 
399  const std::weak_ptr<ome::xml::model::Plane>&
400  getLinkedPlane (OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type::size_type index) const;
401 
412  const std::weak_ptr<ome::xml::model::Plane>&
413  setLinkedPlane (OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type::size_type index,
414  const std::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
415 
426  bool
427  linkPlane (const std::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
428 
444  bool
445  unlinkPlane (const std::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
446 
452  OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type::size_type
453  sizeOfLinkedChannelList () const;
454 
460  OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type
461  getLinkedChannelList () const;
462 
470  const std::weak_ptr<ome::xml::model::Channel>&
471  getLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type::size_type index) const;
472 
483  const std::weak_ptr<ome::xml::model::Channel>&
484  setLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type::size_type index,
485  const std::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
486 
497  bool
498  linkChannel (const std::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
499 
515  bool
516  unlinkChannel (const std::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
517 
523  OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type::size_type
524  sizeOfLinkedInstrumentList () const;
525 
531  OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type
532  getLinkedInstrumentList () const;
533 
541  const std::weak_ptr<ome::xml::model::Instrument>&
542  getLinkedInstrument (OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type::size_type index) const;
543 
554  const std::weak_ptr<ome::xml::model::Instrument>&
555  setLinkedInstrument (OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type::size_type index,
556  const std::shared_ptr<ome::xml::model::Instrument>& instrument_BackReference);
557 
568  bool
569  linkInstrument (const std::shared_ptr<ome::xml::model::Instrument>& instrument_BackReference);
570 
586  bool
587  unlinkInstrument (const std::shared_ptr<ome::xml::model::Instrument>& instrument_BackReference);
588 
594  OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type::size_type
595  sizeOfLinkedLightSourceList () const;
596 
602  OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type
603  getLinkedLightSourceList () const;
604 
612  const std::weak_ptr<ome::xml::model::LightSource>&
613  getLinkedLightSource (OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type::size_type index) const;
614 
625  const std::weak_ptr<ome::xml::model::LightSource>&
626  setLinkedLightSource (OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type::size_type index,
627  const std::shared_ptr<ome::xml::model::LightSource>& lightSource_BackReference);
628 
639  bool
640  linkLightSource (const std::shared_ptr<ome::xml::model::LightSource>& lightSource_BackReference);
641 
657  bool
658  unlinkLightSource (const std::shared_ptr<ome::xml::model::LightSource>& lightSource_BackReference);
659 
665  OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type::size_type
666  sizeOfLinkedProjectList () const;
667 
673  OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type
674  getLinkedProjectList () const;
675 
683  const std::weak_ptr<ome::xml::model::Project>&
684  getLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type::size_type index) const;
685 
696  const std::weak_ptr<ome::xml::model::Project>&
697  setLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type::size_type index,
698  const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
699 
710  bool
711  linkProject (const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
712 
728  bool
729  unlinkProject (const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
730 
736  OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type::size_type
737  sizeOfLinkedExperimenterGroupList () const;
738 
744  OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type
745  getLinkedExperimenterGroupList () const;
746 
754  const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
755  getLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type::size_type index) const;
756 
767  const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
768  setLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type::size_type index,
769  const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
770 
781  bool
782  linkExperimenterGroup (const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
783 
799  bool
800  unlinkExperimenterGroup (const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
801 
807  OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type
808  sizeOfLinkedDatasetList () const;
809 
815  OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type
816  getLinkedDatasetList () const;
817 
825  const std::weak_ptr<ome::xml::model::Dataset>&
826  getLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type index) const;
827 
838  const std::weak_ptr<ome::xml::model::Dataset>&
839  setLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type index,
840  const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
841 
852  bool
853  linkDataset (const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
854 
870  bool
871  unlinkDataset (const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
872 
878  OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type::size_type
879  sizeOfLinkedExperimenterList () const;
880 
886  OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type
887  getLinkedExperimenterList () const;
888 
896  const std::weak_ptr<ome::xml::model::Experimenter>&
897  getLinkedExperimenter (OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type::size_type index) const;
898 
909  const std::weak_ptr<ome::xml::model::Experimenter>&
910  setLinkedExperimenter (OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type::size_type index,
911  const std::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
912 
923  bool
924  linkExperimenter (const std::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
925 
941  bool
942  unlinkExperimenter (const std::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
943 
949  OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type
950  sizeOfLinkedFolderList () const;
951 
957  OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type
958  getLinkedFolderList () const;
959 
967  const std::weak_ptr<ome::xml::model::Folder>&
968  getLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type index) const;
969 
980  const std::weak_ptr<ome::xml::model::Folder>&
981  setLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type index,
982  const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
983 
994  bool
995  linkFolder (const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
996 
1012  bool
1013  unlinkFolder (const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
1014 
1020  OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type::size_type
1021  sizeOfLinkedObjectiveList () const;
1022 
1028  OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type
1029  getLinkedObjectiveList () const;
1030 
1038  const std::weak_ptr<ome::xml::model::Objective>&
1039  getLinkedObjective (OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type::size_type index) const;
1040 
1051  const std::weak_ptr<ome::xml::model::Objective>&
1052  setLinkedObjective (OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type::size_type index,
1053  const std::shared_ptr<ome::xml::model::Objective>& objective_BackReference);
1054 
1065  bool
1066  linkObjective (const std::shared_ptr<ome::xml::model::Objective>& objective_BackReference);
1067 
1083  bool
1084  unlinkObjective (const std::shared_ptr<ome::xml::model::Objective>& objective_BackReference);
1085 
1091  OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type::size_type
1092  sizeOfLinkedDetectorList () const;
1093 
1099  OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type
1100  getLinkedDetectorList () const;
1101 
1109  const std::weak_ptr<ome::xml::model::Detector>&
1110  getLinkedDetector (OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type::size_type index) const;
1111 
1122  const std::weak_ptr<ome::xml::model::Detector>&
1123  setLinkedDetector (OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type::size_type index,
1124  const std::shared_ptr<ome::xml::model::Detector>& detector_BackReference);
1125 
1136  bool
1137  linkDetector (const std::shared_ptr<ome::xml::model::Detector>& detector_BackReference);
1138 
1154  bool
1155  unlinkDetector (const std::shared_ptr<ome::xml::model::Detector>& detector_BackReference);
1156 
1162  OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type::size_type
1163  sizeOfLinkedFilterList () const;
1164 
1170  OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type
1171  getLinkedFilterList () const;
1172 
1180  const std::weak_ptr<ome::xml::model::Filter>&
1181  getLinkedFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type::size_type index) const;
1182 
1193  const std::weak_ptr<ome::xml::model::Filter>&
1194  setLinkedFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type::size_type index,
1195  const std::shared_ptr<ome::xml::model::Filter>& filter_BackReference);
1196 
1207  bool
1208  linkFilter (const std::shared_ptr<ome::xml::model::Filter>& filter_BackReference);
1209 
1225  bool
1226  unlinkFilter (const std::shared_ptr<ome::xml::model::Filter>& filter_BackReference);
1227 
1233  OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type::size_type
1234  sizeOfLinkedDichroicList () const;
1235 
1241  OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type
1242  getLinkedDichroicList () const;
1243 
1251  const std::weak_ptr<ome::xml::model::Dichroic>&
1252  getLinkedDichroic (OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type::size_type index) const;
1253 
1264  const std::weak_ptr<ome::xml::model::Dichroic>&
1265  setLinkedDichroic (OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type::size_type index,
1266  const std::shared_ptr<ome::xml::model::Dichroic>& dichroic_BackReference);
1267 
1278  bool
1279  linkDichroic (const std::shared_ptr<ome::xml::model::Dichroic>& dichroic_BackReference);
1280 
1296  bool
1297  unlinkDichroic (const std::shared_ptr<ome::xml::model::Dichroic>& dichroic_BackReference);
1298 
1304  OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type::size_type
1305  sizeOfLinkedLightPathList () const;
1306 
1312  OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type
1313  getLinkedLightPathList () const;
1314 
1322  const std::weak_ptr<ome::xml::model::LightPath>&
1323  getLinkedLightPath (OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type::size_type index) const;
1324 
1335  const std::weak_ptr<ome::xml::model::LightPath>&
1336  setLinkedLightPath (OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type::size_type index,
1337  const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
1338 
1349  bool
1350  linkLightPath (const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
1351 
1367  bool
1368  unlinkLightPath (const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
1369 
1375  OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type
1376  sizeOfLinkedROIList () const;
1377 
1383  OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type
1384  getLinkedROIList () const;
1385 
1393  const std::weak_ptr<ome::xml::model::ROI>&
1394  getLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type index) const;
1395 
1406  const std::weak_ptr<ome::xml::model::ROI>&
1407  setLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type index,
1408  const std::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
1409 
1420  bool
1421  linkROI (const std::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
1422 
1438  bool
1439  unlinkROI (const std::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
1440 
1446  OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type::size_type
1447  sizeOfLinkedShapeList () const;
1448 
1454  OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type
1455  getLinkedShapeList () const;
1456 
1464  const std::weak_ptr<ome::xml::model::Shape>&
1465  getLinkedShape (OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type::size_type index) const;
1466 
1477  const std::weak_ptr<ome::xml::model::Shape>&
1478  setLinkedShape (OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type::size_type index,
1479  const std::shared_ptr<ome::xml::model::Shape>& shape_BackReference);
1480 
1491  bool
1492  linkShape (const std::shared_ptr<ome::xml::model::Shape>& shape_BackReference);
1493 
1509  bool
1510  unlinkShape (const std::shared_ptr<ome::xml::model::Shape>& shape_BackReference);
1511 
1517  OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type::size_type
1518  sizeOfLinkedPlateList () const;
1519 
1525  OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type
1526  getLinkedPlateList () const;
1527 
1535  const std::weak_ptr<ome::xml::model::Plate>&
1536  getLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type::size_type index) const;
1537 
1548  const std::weak_ptr<ome::xml::model::Plate>&
1549  setLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type::size_type index,
1550  const std::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1551 
1562  bool
1563  linkPlate (const std::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1564 
1580  bool
1581  unlinkPlate (const std::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1582 
1588  OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type::size_type
1589  sizeOfLinkedReagentList () const;
1590 
1596  OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type
1597  getLinkedReagentList () const;
1598 
1606  const std::weak_ptr<ome::xml::model::Reagent>&
1607  getLinkedReagent (OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type::size_type index) const;
1608 
1619  const std::weak_ptr<ome::xml::model::Reagent>&
1620  setLinkedReagent (OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type::size_type index,
1621  const std::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1622 
1633  bool
1634  linkReagent (const std::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1635 
1651  bool
1652  unlinkReagent (const std::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1653 
1659  OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type::size_type
1660  sizeOfLinkedScreenList () const;
1661 
1667  OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type
1668  getLinkedScreenList () const;
1669 
1677  const std::weak_ptr<ome::xml::model::Screen>&
1678  getLinkedScreen (OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type::size_type index) const;
1679 
1690  const std::weak_ptr<ome::xml::model::Screen>&
1691  setLinkedScreen (OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type::size_type index,
1692  const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1693 
1704  bool
1705  linkScreen (const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1706 
1722  bool
1723  unlinkScreen (const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1724 
1730  OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type::size_type
1731  sizeOfLinkedPlateAcquisitionList () const;
1732 
1738  OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type
1739  getLinkedPlateAcquisitionList () const;
1740 
1748  const std::weak_ptr<ome::xml::model::PlateAcquisition>&
1749  getLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type::size_type index) const;
1750 
1761  const std::weak_ptr<ome::xml::model::PlateAcquisition>&
1762  setLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type::size_type index,
1763  const std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1764 
1775  bool
1776  linkPlateAcquisition (const std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1777 
1793  bool
1794  unlinkPlateAcquisition (const std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1795 
1801  OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type::size_type
1802  sizeOfLinkedWellList () const;
1803 
1809  OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type
1810  getLinkedWellList () const;
1811 
1819  const std::weak_ptr<ome::xml::model::Well>&
1820  getLinkedWell (OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type::size_type index) const;
1821 
1832  const std::weak_ptr<ome::xml::model::Well>&
1833  setLinkedWell (OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type::size_type index,
1834  const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
1835 
1846  bool
1847  linkWell (const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
1848 
1864  bool
1865  unlinkWell (const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
1866 
1867  protected:
1868  // Documented in base class.
1869  virtual void
1870  asXMLElementInternal (common::xml::dom::Document& document,
1871  common::xml::dom::Element& element) const;
1872 
1873  public:
1874  // Documented in superclass.
1875  const std::string&
1876  getXMLNamespace() const;
1877  };
1878 
1879  }
1880  }
1881 }
1882 
1883 #endif // OME_XML_MODEL_ANNOTATION_H
1884 
1885 /*
1886  * Local Variables:
1887  * mode:C++
1888  * End:
1889  */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
ome::xml::model::Annotation::getLinkedDetectorList
OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type getLinkedDetectorList() const
Get the linked Detector list.
Definition: Annotation.cpp:1228
ome::xml::model::Annotation::sizeOfLinkedObjectiveList
OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type sizeOfLinkedObjectiveList() const
Get size of linked Objective list.
Definition: Annotation.cpp:1164
ome::xml::model::Annotation::getDescription
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Annotation.cpp:505
ome::xml::model::Annotation::unlinkLightPath
bool unlinkLightPath(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPath.
Definition: Annotation.cpp:1437
ome::xml::model::Annotation::getLinkedPlane
const std::weak_ptr< ome::xml::model::Plane > & getLinkedPlane(OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type index) const
Get linked Plane.
Definition: Annotation.cpp:654
ome::xml::model::Annotation::asXMLElementInternal
virtual void asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: Annotation.cpp:1859
ome::xml::model::Annotation::linkPlane
bool linkPlane(const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Link Plane.
Definition: Annotation.cpp:670
ome::xml::model::Annotation::sizeOfLinkedWellList
OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type sizeOfLinkedWellList() const
Get size of linked Well list.
Definition: Annotation.cpp:1802
ome::xml::model::Annotation::setLinkedDichroic
const std::weak_ptr< ome::xml::model::Dichroic > & setLinkedDichroic(OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
Set linked Dichroic.
Definition: Annotation.cpp:1356
ome::xml::model::Annotation::unlinkPlate
bool unlinkPlate(const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Unlink Plate.
Definition: Annotation.cpp:1611
ome::xml::model::Annotation::getLinkedAnnotation
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Annotation.cpp:538
ome::xml::model::Annotation::getLinkedDichroicList
OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type getLinkedDichroicList() const
Get the linked Dichroic list.
Definition: Annotation.cpp:1344
ome::xml::model::Annotation::sizeOfLinkedShapeList
OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type sizeOfLinkedShapeList() const
Get size of linked Shape list.
Definition: Annotation.cpp:1512
ome::xml::model::Annotation::linkChannel
bool linkChannel(const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Link Channel.
Definition: Annotation.cpp:728
ome::xml::model::Annotation::linkExperimenter
bool linkExperimenter(const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Link Experimenter.
Definition: Annotation.cpp:1076
ome::xml::model::Annotation::sizeOfLinkedPlaneList
OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type sizeOfLinkedPlaneList() const
Get size of linked Plane list.
Definition: Annotation.cpp:642
ome::xml::model::Annotation::setLinkedPlateAcquisition
const std::weak_ptr< ome::xml::model::PlateAcquisition > & setLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Set linked PlateAcquisition.
Definition: Annotation.cpp:1762
ome::xml::model::Annotation::unlinkFilter
bool unlinkFilter(const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
Unlink Filter.
Definition: Annotation.cpp:1321
ome::xml::model::Annotation::sizeOfLinkedDatasetList
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Annotation.cpp:990
ome::xml::model::Annotation::setLinkedImage
const std::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Set linked Image.
Definition: Annotation.cpp:602
ome::xml::model::Annotation::setNamespace
void setNamespace(std::shared_ptr< std::string > &namespace_)
Set the Namespace property.
Definition: Annotation.cpp:463
ome::xml::model::Annotation::getLinkedWell
const std::weak_ptr< ome::xml::model::Well > & getLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type index) const
Get linked Well.
Definition: Annotation.cpp:1814
ome::xml::model::Annotation::setLinkedReagent
const std::weak_ptr< ome::xml::model::Reagent > & setLinkedReagent(OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Set linked Reagent.
Definition: Annotation.cpp:1646
ome::xml::model::Annotation::unlinkScreen
bool unlinkScreen(const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Annotation.cpp:1727
ome::xml::model::Annotation::getLinkedDataset
const std::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index) const
Get linked Dataset.
Definition: Annotation.cpp:1002
ome::xml::model::Annotation::getLinkedFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type getLinkedFilterList() const
Get the linked Filter list.
Definition: Annotation.cpp:1286
ome::xml::model::Annotation::~Annotation
virtual ~Annotation()
Destructor.
Definition: Annotation.cpp:337
ome::xml::model::OMEModelObject::indexed_container::type
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
ome::xml::model::Annotation::getLinkedFolder
const std::weak_ptr< ome::xml::model::Folder > & getLinkedFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index) const
Get linked Folder.
Definition: Annotation.cpp:1118
ome::xml::model::Annotation::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Annotation.cpp:532
ome::xml::model::Annotation::getLinkedPlateList
OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type getLinkedPlateList() const
Get the linked Plate list.
Definition: Annotation.cpp:1576
ome::xml::model::Annotation::sizeOfLinkedDetectorList
OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type sizeOfLinkedDetectorList() const
Get size of linked Detector list.
Definition: Annotation.cpp:1222
ome::xml::model::Annotation::linkDataset
bool linkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Annotation.cpp:1018
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Annotation::getLinkedFolderList
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type getLinkedFolderList() const
Get the linked Folder list.
Definition: Annotation.cpp:1112
ome::xml::model::Annotation::unlinkFolder
bool unlinkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: Annotation.cpp:1147
ome::xml::model::Annotation::linkProject
bool linkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Annotation.cpp:902
ome::xml::model::Annotation::getLinkedScreenList
OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type getLinkedScreenList() const
Get the linked Screen list.
Definition: Annotation.cpp:1692
ome::xml::model::Annotation::getLinkedProject
const std::weak_ptr< ome::xml::model::Project > & getLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index) const
Get linked Project.
Definition: Annotation.cpp:886
ome::xml::model::Annotation::getLinkedLightSource
const std::weak_ptr< ome::xml::model::LightSource > & getLinkedLightSource(OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type index) const
Get linked LightSource.
Definition: Annotation.cpp:828
ome::xml::model::Annotation::linkShape
bool linkShape(const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
Link Shape.
Definition: Annotation.cpp:1540
ome::xml::model::Annotation::getLinkedPlate
const std::weak_ptr< ome::xml::model::Plate > & getLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type index) const
Get linked Plate.
Definition: Annotation.cpp:1582
ome::xml::model::Annotation::sizeOfLinkedExperimenterList
OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type sizeOfLinkedExperimenterList() const
Get size of linked Experimenter list.
Definition: Annotation.cpp:1048
ome::xml::model::Annotation::linkObjective
bool linkObjective(const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
Link Objective.
Definition: Annotation.cpp:1192
ome::xml::model::Annotation::setLinkedPlate
const std::weak_ptr< ome::xml::model::Plate > & setLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Set linked Plate.
Definition: Annotation.cpp:1588
ome::xml::model::Annotation::linkReagent
bool linkReagent(const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Link Reagent.
Definition: Annotation.cpp:1656
ome::xml::model::Annotation::sizeOfLinkedProjectList
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: Annotation.cpp:874
ome::xml::model::Annotation::getLinkedPlaneList
OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type getLinkedPlaneList() const
Get the linked Plane list.
Definition: Annotation.cpp:648
ome::xml::model::Annotation::unlinkDetector
bool unlinkDetector(const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
Unlink Detector.
Definition: Annotation.cpp:1263
ome::xml::model::Annotation::getLinkedPlateAcquisition
const std::weak_ptr< ome::xml::model::PlateAcquisition > & getLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type index) const
Get linked PlateAcquisition.
Definition: Annotation.cpp:1756
ome::xml::model::Annotation::linkDichroic
bool linkDichroic(const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
Link Dichroic.
Definition: Annotation.cpp:1366
ome::xml::model::Annotation::unlinkDataset
bool unlinkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Annotation.cpp:1031
ome::xml::model::Annotation::linkWell
bool linkWell(const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Link Well.
Definition: Annotation.cpp:1830
ome::xml::model::Annotation::unlinkDichroic
bool unlinkDichroic(const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
Unlink Dichroic.
Definition: Annotation.cpp:1379
ome::xml::model::Annotation::getLinkedPlateAcquisitionList
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type getLinkedPlateAcquisitionList() const
Get the linked PlateAcquisition list.
Definition: Annotation.cpp:1750
ome::xml::model::Annotation::linkPlateAcquisition
bool linkPlateAcquisition(const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: Annotation.cpp:1772
ome::xml::model::Annotation::getLinkedWellList
OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type getLinkedWellList() const
Get the linked Well list.
Definition: Annotation.cpp:1808
ome::xml::model::Annotation::getLinkedImage
const std::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: Annotation.cpp:596
ome::xml::model::Annotation::linkInstrument
bool linkInstrument(const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Link Instrument.
Definition: Annotation.cpp:786
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
ome::xml::model::Annotation::impl
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Annotation.h:103
ome::xml::model::Annotation::linkScreen
bool linkScreen(const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Link Screen.
Definition: Annotation.cpp:1714
ome::xml::model::Annotation::sizeOfLinkedInstrumentList
OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type sizeOfLinkedInstrumentList() const
Get size of linked Instrument list.
Definition: Annotation.cpp:758
ome::xml::model::Annotation::unlinkObjective
bool unlinkObjective(const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
Unlink Objective.
Definition: Annotation.cpp:1205
ome::xml::model::Annotation::unlinkROI
bool unlinkROI(const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Unlink ROI.
Definition: Annotation.cpp:1495
ome::xml::model::Annotation::linkPlate
bool linkPlate(const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Link Plate.
Definition: Annotation.cpp:1598
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Annotation::getLinkedReagentList
OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type getLinkedReagentList() const
Get the linked Reagent list.
Definition: Annotation.cpp:1634
ome::xml::model::Annotation::getLinkedChannelList
OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type getLinkedChannelList() const
Get the linked Channel list.
Definition: Annotation.cpp:706
ome::xml::model::Annotation::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Annotation.cpp:342
ome::xml::model::Annotation::setLinkedChannel
const std::weak_ptr< ome::xml::model::Channel > & setLinkedChannel(OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Set linked Channel.
Definition: Annotation.cpp:718
ome::xml::model::Annotation::setLinkedExperimenterGroup
const std::weak_ptr< ome::xml::model::ExperimenterGroup > & setLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Set linked ExperimenterGroup.
Definition: Annotation.cpp:950
ome::xml::model::Annotation
Annotation model object.
Definition: Annotation.h:100
ome::xml::model::Annotation::getID
const std::string & getID() const
Get the ID property.
Definition: Annotation.cpp:470
ome::xml::model::Annotation::sizeOfLinkedPlateList
OMEModelObject::indexed_container< ome::xml::model::Plate, std::weak_ptr >::type::size_type sizeOfLinkedPlateList() const
Get size of linked Plate list.
Definition: Annotation.cpp:1570
ome::xml::model::Annotation::unlinkReagent
bool unlinkReagent(const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Unlink Reagent.
Definition: Annotation.cpp:1669
ome::xml::model::Annotation::getLinkedShapeList
OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type getLinkedShapeList() const
Get the linked Shape list.
Definition: Annotation.cpp:1518
ome::xml::model::Annotation::setLinkedObjective
const std::weak_ptr< ome::xml::model::Objective > & setLinkedObjective(OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
Set linked Objective.
Definition: Annotation.cpp:1182
ome::xml::model::Annotation::setLinkedDetector
const std::weak_ptr< ome::xml::model::Detector > & setLinkedDetector(OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
Set linked Detector.
Definition: Annotation.cpp:1240
ome::xml::model::Annotation::getLinkedROI
const std::weak_ptr< ome::xml::model::ROI > & getLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index) const
Get linked ROI.
Definition: Annotation.cpp:1466
ome::xml::model::Annotation::getLinkedROIList
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Annotation.cpp:1460
ome::xml::model::Annotation::getLinkedExperimenterList
OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type getLinkedExperimenterList() const
Get the linked Experimenter list.
Definition: Annotation.cpp:1054
ome::xml::model::Annotation::sizeOfLinkedFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type sizeOfLinkedFilterList() const
Get size of linked Filter list.
Definition: Annotation.cpp:1280
ome::xml::model::Annotation::getLinkedChannel
const std::weak_ptr< ome::xml::model::Channel > & getLinkedChannel(OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type index) const
Get linked Channel.
Definition: Annotation.cpp:712
ome::xml::model::Annotation::setDescription
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Annotation.cpp:519
ome::xml::model::Annotation::setLinkedLightSource
const std::weak_ptr< ome::xml::model::LightSource > & setLinkedLightSource(OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
Set linked LightSource.
Definition: Annotation.cpp:834
ome::xml::model::Annotation::setLinkedAnnotation
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Annotation.cpp:544
ome::xml::model::Annotation::getLinkedProjectList
OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Annotation.cpp:880
ome::xml::model::Annotation::setLinkedLightPath
const std::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPath(OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Set linked LightPath.
Definition: Annotation.cpp:1414
ome::xml::model::Annotation::sizeOfLinkedReagentList
OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type sizeOfLinkedReagentList() const
Get size of linked Reagent list.
Definition: Annotation.cpp:1628
ome::xml::model::Annotation::setLinkedPlane
const std::weak_ptr< ome::xml::model::Plane > & setLinkedPlane(OMEModelObject::indexed_container< ome::xml::model::Plane, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Set linked Plane.
Definition: Annotation.cpp:660
ome::xml::model::Annotation::setLinkedShape
const std::weak_ptr< ome::xml::model::Shape > & setLinkedShape(OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
Set linked Shape.
Definition: Annotation.cpp:1530
ome::xml::model::Annotation::getLinkedLightSourceList
OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type getLinkedLightSourceList() const
Get the linked LightSource list.
Definition: Annotation.cpp:822
ome::xml::model::Annotation::sizeOfLinkedExperimenterGroupList
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type sizeOfLinkedExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: Annotation.cpp:932
ome::xml::model::Annotation::getLinkedDichroic
const std::weak_ptr< ome::xml::model::Dichroic > & getLinkedDichroic(OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type index) const
Get linked Dichroic.
Definition: Annotation.cpp:1350
ome::xml::model::Annotation::setID
void setID(const std::string &id)
Set the ID property.
Definition: Annotation.cpp:477
ome::xml::model::Annotation::sizeOfLinkedChannelList
OMEModelObject::indexed_container< ome::xml::model::Channel, std::weak_ptr >::type::size_type sizeOfLinkedChannelList() const
Get size of linked Channel list.
Definition: Annotation.cpp:700
ome::xml::model::Annotation::unlinkImage
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Annotation.cpp:625
ome::xml::model::Annotation::getLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Annotation.cpp:590
ome::xml::model::Annotation::update
virtual SKIP void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Annotation.cpp:348
ome::xml::model::Annotation::getLinkedShape
const std::weak_ptr< ome::xml::model::Shape > & getLinkedShape(OMEModelObject::indexed_container< ome::xml::model::Shape, std::weak_ptr >::type::size_type index) const
Get linked Shape.
Definition: Annotation.cpp:1524
ome::xml::model::Annotation::getLinkedLightPath
const std::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPath(OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index) const
Get linked LightPath.
Definition: Annotation.cpp:1408
ome::xml::model::Annotation::link
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Annotation.cpp:419
ome::xml::model::Annotation::unlinkExperimenterGroup
bool unlinkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Annotation.cpp:973
ome::xml::model::Annotation::setLinkedROI
const std::weak_ptr< ome::xml::model::ROI > & setLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Set linked ROI.
Definition: Annotation.cpp:1472
ome::xml::model::Annotation::sizeOfLinkedLightPathList
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type sizeOfLinkedLightPathList() const
Get size of linked LightPath list.
Definition: Annotation.cpp:1396
ome::xml::model::Annotation::setLinkedWell
const std::weak_ptr< ome::xml::model::Well > & setLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Set linked Well.
Definition: Annotation.cpp:1820
ome::xml::model::Annotation::sizeOfLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, std::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Annotation.cpp:584
ome::xml::model::Annotation::getLinkedExperimenter
const std::weak_ptr< ome::xml::model::Experimenter > & getLinkedExperimenter(OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type index) const
Get linked Experimenter.
Definition: Annotation.cpp:1060
ome::xml::model::Annotation::Impl
Private implementation details of Annotation model object.
Definition: Annotation.cpp:93
ome::xml::model::Annotation::unlinkShape
bool unlinkShape(const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
Unlink Shape.
Definition: Annotation.cpp:1553
ome::xml::model::Annotation::unlinkPlane
bool unlinkPlane(const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Unlink Plane.
Definition: Annotation.cpp:683
ome::xml::model::Annotation::unlinkChannel
bool unlinkChannel(const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Unlink Channel.
Definition: Annotation.cpp:741
ome::xml::model::Annotation::linkAnnotation
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Annotation.cpp:554
ome::xml::model::Annotation::unlinkExperimenter
bool unlinkExperimenter(const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Unlink Experimenter.
Definition: Annotation.cpp:1089
ome::xml::model::Annotation::getLinkedInstrument
const std::weak_ptr< ome::xml::model::Instrument > & getLinkedInstrument(OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type index) const
Get linked Instrument.
Definition: Annotation.cpp:770
ome::xml::model::Annotation::linkImage
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Annotation.cpp:612
ome::xml::model::Annotation::setLinkedFolder
const std::weak_ptr< ome::xml::model::Folder > & setLinkedFolder(OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Set linked Folder.
Definition: Annotation.cpp:1124
ome::xml::model::Annotation::unlinkLightSource
bool unlinkLightSource(const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
Unlink LightSource.
Definition: Annotation.cpp:857
ome::xml::model::Annotation::getLinkedObjective
const std::weak_ptr< ome::xml::model::Objective > & getLinkedObjective(OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type::size_type index) const
Get linked Objective.
Definition: Annotation.cpp:1176
ome::xml::model::Annotation::getLinkedExperimenterGroupList
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type getLinkedExperimenterGroupList() const
Get the linked ExperimenterGroup list.
Definition: Annotation.cpp:938
ome::xml::model::Annotation::setLinkedScreen
const std::weak_ptr< ome::xml::model::Screen > & setLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Set linked Screen.
Definition: Annotation.cpp:1704
ome::xml::model::Annotation::getLinkedDatasetList
OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Annotation.cpp:996
ome::xml::model::Annotation::sizeOfLinkedPlateAcquisitionList
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, std::weak_ptr >::type::size_type sizeOfLinkedPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: Annotation.cpp:1744
ome::xml::model::Annotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Annotation.cpp:1935
ome::xml::model::Annotation::setLinkedProject
const std::weak_ptr< ome::xml::model::Project > & setLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Set linked Project.
Definition: Annotation.cpp:892
ome::xml::model::Annotation::sizeOfLinkedROIList
OMEModelObject::indexed_container< ome::xml::model::ROI, std::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Annotation.cpp:1454
ome::xml::model::Annotation::setLinkedFilter
const std::weak_ptr< ome::xml::model::Filter > & setLinkedFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
Set linked Filter.
Definition: Annotation.cpp:1298
ome::xml::model::Annotation::getLinkedInstrumentList
OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type getLinkedInstrumentList() const
Get the linked Instrument list.
Definition: Annotation.cpp:764
ome::xml::model::Annotation::sizeOfLinkedLightSourceList
OMEModelObject::indexed_container< ome::xml::model::LightSource, std::weak_ptr >::type::size_type sizeOfLinkedLightSourceList() const
Get size of linked LightSource list.
Definition: Annotation.cpp:816
ome::xml::model::Annotation::linkFilter
bool linkFilter(const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
Link Filter.
Definition: Annotation.cpp:1308
ome::xml::model::Annotation::getLinkedExperimenterGroup
const std::weak_ptr< ome::xml::model::ExperimenterGroup > & getLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, std::weak_ptr >::type::size_type index) const
Get linked ExperimenterGroup.
Definition: Annotation.cpp:944
ome::xml::model::Annotation::linkROI
bool linkROI(const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Link ROI.
Definition: Annotation.cpp:1482
ome::xml::model::Annotation::Annotation
Annotation()
Default constructor.
Definition: Annotation.cpp:318
ome::xml::model::Annotation::getLinkedDetector
const std::weak_ptr< ome::xml::model::Detector > & getLinkedDetector(OMEModelObject::indexed_container< ome::xml::model::Detector, std::weak_ptr >::type::size_type index) const
Get linked Detector.
Definition: Annotation.cpp:1234
ome::xml::model::Annotation::setLinkedDataset
const std::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Set linked Dataset.
Definition: Annotation.cpp:1008
ome::xml::model::Annotation::linkExperimenterGroup
bool linkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Annotation.cpp:960
ome::xml::model::Annotation::getAnnotator
std::shared_ptr< std::string > getAnnotator()
Get the Annotator property.
Definition: Annotation.cpp:484
ome::xml::model::Annotation::getNamespace
std::shared_ptr< std::string > getNamespace()
Get the Namespace property.
Definition: Annotation.cpp:449
ome::xml::model::Annotation::linkFolder
bool linkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: Annotation.cpp:1134
ome::xml::model::Annotation::unlinkWell
bool unlinkWell(const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Unlink Well.
Definition: Annotation.cpp:1843
ome::xml::model::Annotation::unlinkAnnotation
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Annotation.cpp:567
ome::xml::model::Annotation::getLinkedReagent
const std::weak_ptr< ome::xml::model::Reagent > & getLinkedReagent(OMEModelObject::indexed_container< ome::xml::model::Reagent, std::weak_ptr >::type::size_type index) const
Get linked Reagent.
Definition: Annotation.cpp:1640
ome::xml::model::Annotation::linkLightPath
bool linkLightPath(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPath.
Definition: Annotation.cpp:1424
ome::xml::model::Annotation::sizeOfLinkedDichroicList
OMEModelObject::indexed_container< ome::xml::model::Dichroic, std::weak_ptr >::type::size_type sizeOfLinkedDichroicList() const
Get size of linked Dichroic list.
Definition: Annotation.cpp:1338
ome::xml::model::Annotation::getLinkedScreen
const std::weak_ptr< ome::xml::model::Screen > & getLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type index) const
Get linked Screen.
Definition: Annotation.cpp:1698
ome::xml::model::Annotation::unlinkPlateAcquisition
bool unlinkPlateAcquisition(const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: Annotation.cpp:1785
ome::xml::model::Annotation::unlinkProject
bool unlinkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Annotation.cpp:915
ome::xml::model::Annotation::getLinkedFilter
const std::weak_ptr< ome::xml::model::Filter > & getLinkedFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, std::weak_ptr >::type::size_type index) const
Get linked Filter.
Definition: Annotation.cpp:1292
ome::xml::model::Annotation::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Annotation.cpp:526
ome::xml::model::Annotation::setLinkedInstrument
const std::weak_ptr< ome::xml::model::Instrument > & setLinkedInstrument(OMEModelObject::indexed_container< ome::xml::model::Instrument, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set linked Instrument.
Definition: Annotation.cpp:776
ome::xml::model::Annotation::setLinkedExperimenter
const std::weak_ptr< ome::xml::model::Experimenter > & setLinkedExperimenter(OMEModelObject::indexed_container< ome::xml::model::Experimenter, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Set linked Experimenter.
Definition: Annotation.cpp:1066
ome::xml::model::Annotation::sizeOfLinkedFolderList
OMEModelObject::indexed_container< ome::xml::model::Folder, std::weak_ptr >::type::size_type sizeOfLinkedFolderList() const
Get size of linked Folder list.
Definition: Annotation.cpp:1106
ome::xml::model::Annotation::getLinkedLightPathList
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type getLinkedLightPathList() const
Get the linked LightPath list.
Definition: Annotation.cpp:1402
ome::xml::model::Annotation::setAnnotator
void setAnnotator(std::shared_ptr< std::string > &annotator)
Set the Annotator property.
Definition: Annotation.cpp:498
ome::xml::model::Annotation::linkLightSource
bool linkLightSource(const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
Link LightSource.
Definition: Annotation.cpp:844
ome::xml::model::Annotation::getLinkedObjectiveList
OMEModelObject::indexed_container< ome::xml::model::Objective, std::weak_ptr >::type getLinkedObjectiveList() const
Get the linked Objective list.
Definition: Annotation.cpp:1170
ome::xml::model::Annotation::unlinkInstrument
bool unlinkInstrument(const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Unlink Instrument.
Definition: Annotation.cpp:799
ome::xml::model::Annotation::linkDetector
bool linkDetector(const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
Link Detector.
Definition: Annotation.cpp:1250
ome::xml::model::Annotation::sizeOfLinkedScreenList
OMEModelObject::indexed_container< ome::xml::model::Screen, std::weak_ptr >::type::size_type sizeOfLinkedScreenList() const
Get size of linked Screen list.
Definition: Annotation.cpp:1686
Generated on Mon Dec 4 2017 07:41:11 for ome-xml by   doxygen 1.8.13