ome-xml  5.5.1
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 
126  private:
128  Annotation&
129  operator= (const Annotation&);
130 
131  public:
132  // -- OMEModelObject API methods --
133 
135  virtual void
136  update(const common::xml::dom::Element& element,
137  ome::xml::model::OMEModel& model);
138 
139  public:
140  // -- Annotation API methods --
141 
143  bool
144  link (std::shared_ptr<Reference>& reference,
145  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
146 
152  std::shared_ptr<std::string>
153  getNamespace ();
154 
160  const std::shared_ptr<std::string>
161  getNamespace () const;
162 
168  void
169  setNamespace (std::shared_ptr<std::string>& namespace_);
170 
176  const std::string&
177  getID () const;
178 
184  void
185  setID (const std::string& id);
186 
192  std::shared_ptr<std::string>
193  getAnnotator ();
194 
200  const std::shared_ptr<std::string>
201  getAnnotator () const;
202 
208  void
209  setAnnotator (std::shared_ptr<std::string>& annotator);
210 
216  std::shared_ptr<std::string>
217  getDescription ();
218 
224  const std::shared_ptr<std::string>
225  getDescription () const;
226 
232  void
233  setDescription (std::shared_ptr<std::string>& description);
234 
240  OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type::size_type
241  sizeOfLinkedAnnotationList () const;
242 
248  OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type
249  getLinkedAnnotationList () const;
250 
258  const std::weak_ptr<ome::xml::model::Annotation>&
259  getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type::size_type index) const;
260 
271  const std::weak_ptr<ome::xml::model::Annotation>&
272  setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, std::weak_ptr>::type::size_type index,
273  const std::shared_ptr<ome::xml::model::Annotation>& annotation);
274 
285  bool
286  linkAnnotation (const std::shared_ptr<ome::xml::model::Annotation>& annotation);
287 
303  bool
304  unlinkAnnotation (const std::shared_ptr<ome::xml::model::Annotation>& annotation);
305 
311  OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type::size_type
312  sizeOfLinkedImageList () const;
313 
319  OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type
320  getLinkedImageList () const;
321 
329  const std::weak_ptr<ome::xml::model::Image>&
330  getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type::size_type index) const;
331 
342  const std::weak_ptr<ome::xml::model::Image>&
343  setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, std::weak_ptr>::type::size_type index,
344  const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
345 
356  bool
357  linkImage (const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
358 
374  bool
375  unlinkImage (const std::shared_ptr<ome::xml::model::Image>& image_BackReference);
376 
382  OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type::size_type
383  sizeOfLinkedPlaneList () const;
384 
390  OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type
391  getLinkedPlaneList () const;
392 
400  const std::weak_ptr<ome::xml::model::Plane>&
401  getLinkedPlane (OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type::size_type index) const;
402 
413  const std::weak_ptr<ome::xml::model::Plane>&
414  setLinkedPlane (OMEModelObject::indexed_container<ome::xml::model::Plane, std::weak_ptr>::type::size_type index,
415  const std::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
416 
427  bool
428  linkPlane (const std::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
429 
445  bool
446  unlinkPlane (const std::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
447 
453  OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type::size_type
454  sizeOfLinkedChannelList () const;
455 
461  OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type
462  getLinkedChannelList () const;
463 
471  const std::weak_ptr<ome::xml::model::Channel>&
472  getLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type::size_type index) const;
473 
484  const std::weak_ptr<ome::xml::model::Channel>&
485  setLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, std::weak_ptr>::type::size_type index,
486  const std::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
487 
498  bool
499  linkChannel (const std::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
500 
516  bool
517  unlinkChannel (const std::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
518 
524  OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type::size_type
525  sizeOfLinkedInstrumentList () const;
526 
532  OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type
533  getLinkedInstrumentList () const;
534 
542  const std::weak_ptr<ome::xml::model::Instrument>&
543  getLinkedInstrument (OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type::size_type index) const;
544 
555  const std::weak_ptr<ome::xml::model::Instrument>&
556  setLinkedInstrument (OMEModelObject::indexed_container<ome::xml::model::Instrument, std::weak_ptr>::type::size_type index,
557  const std::shared_ptr<ome::xml::model::Instrument>& instrument_BackReference);
558 
569  bool
570  linkInstrument (const std::shared_ptr<ome::xml::model::Instrument>& instrument_BackReference);
571 
587  bool
588  unlinkInstrument (const std::shared_ptr<ome::xml::model::Instrument>& instrument_BackReference);
589 
595  OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type::size_type
596  sizeOfLinkedLightSourceList () const;
597 
603  OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type
604  getLinkedLightSourceList () const;
605 
613  const std::weak_ptr<ome::xml::model::LightSource>&
614  getLinkedLightSource (OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type::size_type index) const;
615 
626  const std::weak_ptr<ome::xml::model::LightSource>&
627  setLinkedLightSource (OMEModelObject::indexed_container<ome::xml::model::LightSource, std::weak_ptr>::type::size_type index,
628  const std::shared_ptr<ome::xml::model::LightSource>& lightSource_BackReference);
629 
640  bool
641  linkLightSource (const std::shared_ptr<ome::xml::model::LightSource>& lightSource_BackReference);
642 
658  bool
659  unlinkLightSource (const std::shared_ptr<ome::xml::model::LightSource>& lightSource_BackReference);
660 
666  OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type::size_type
667  sizeOfLinkedProjectList () const;
668 
674  OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type
675  getLinkedProjectList () const;
676 
684  const std::weak_ptr<ome::xml::model::Project>&
685  getLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type::size_type index) const;
686 
697  const std::weak_ptr<ome::xml::model::Project>&
698  setLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, std::weak_ptr>::type::size_type index,
699  const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
700 
711  bool
712  linkProject (const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
713 
729  bool
730  unlinkProject (const std::shared_ptr<ome::xml::model::Project>& project_BackReference);
731 
737  OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type::size_type
738  sizeOfLinkedExperimenterGroupList () const;
739 
745  OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type
746  getLinkedExperimenterGroupList () const;
747 
755  const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
756  getLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type::size_type index) const;
757 
768  const std::weak_ptr<ome::xml::model::ExperimenterGroup>&
769  setLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, std::weak_ptr>::type::size_type index,
770  const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
771 
782  bool
783  linkExperimenterGroup (const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
784 
800  bool
801  unlinkExperimenterGroup (const std::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
802 
808  OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type
809  sizeOfLinkedDatasetList () const;
810 
816  OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type
817  getLinkedDatasetList () const;
818 
826  const std::weak_ptr<ome::xml::model::Dataset>&
827  getLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type index) const;
828 
839  const std::weak_ptr<ome::xml::model::Dataset>&
840  setLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, std::weak_ptr>::type::size_type index,
841  const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
842 
853  bool
854  linkDataset (const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
855 
871  bool
872  unlinkDataset (const std::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
873 
879  OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type::size_type
880  sizeOfLinkedExperimenterList () const;
881 
887  OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type
888  getLinkedExperimenterList () const;
889 
897  const std::weak_ptr<ome::xml::model::Experimenter>&
898  getLinkedExperimenter (OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type::size_type index) const;
899 
910  const std::weak_ptr<ome::xml::model::Experimenter>&
911  setLinkedExperimenter (OMEModelObject::indexed_container<ome::xml::model::Experimenter, std::weak_ptr>::type::size_type index,
912  const std::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
913 
924  bool
925  linkExperimenter (const std::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
926 
942  bool
943  unlinkExperimenter (const std::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
944 
950  OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type
951  sizeOfLinkedFolderList () const;
952 
958  OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type
959  getLinkedFolderList () const;
960 
968  const std::weak_ptr<ome::xml::model::Folder>&
969  getLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type index) const;
970 
981  const std::weak_ptr<ome::xml::model::Folder>&
982  setLinkedFolder (OMEModelObject::indexed_container<ome::xml::model::Folder, std::weak_ptr>::type::size_type index,
983  const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
984 
995  bool
996  linkFolder (const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
997 
1013  bool
1014  unlinkFolder (const std::shared_ptr<ome::xml::model::Folder>& folder_BackReference);
1015 
1021  OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type::size_type
1022  sizeOfLinkedObjectiveList () const;
1023 
1029  OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type
1030  getLinkedObjectiveList () const;
1031 
1039  const std::weak_ptr<ome::xml::model::Objective>&
1040  getLinkedObjective (OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type::size_type index) const;
1041 
1052  const std::weak_ptr<ome::xml::model::Objective>&
1053  setLinkedObjective (OMEModelObject::indexed_container<ome::xml::model::Objective, std::weak_ptr>::type::size_type index,
1054  const std::shared_ptr<ome::xml::model::Objective>& objective_BackReference);
1055 
1066  bool
1067  linkObjective (const std::shared_ptr<ome::xml::model::Objective>& objective_BackReference);
1068 
1084  bool
1085  unlinkObjective (const std::shared_ptr<ome::xml::model::Objective>& objective_BackReference);
1086 
1092  OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type::size_type
1093  sizeOfLinkedDetectorList () const;
1094 
1100  OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type
1101  getLinkedDetectorList () const;
1102 
1110  const std::weak_ptr<ome::xml::model::Detector>&
1111  getLinkedDetector (OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type::size_type index) const;
1112 
1123  const std::weak_ptr<ome::xml::model::Detector>&
1124  setLinkedDetector (OMEModelObject::indexed_container<ome::xml::model::Detector, std::weak_ptr>::type::size_type index,
1125  const std::shared_ptr<ome::xml::model::Detector>& detector_BackReference);
1126 
1137  bool
1138  linkDetector (const std::shared_ptr<ome::xml::model::Detector>& detector_BackReference);
1139 
1155  bool
1156  unlinkDetector (const std::shared_ptr<ome::xml::model::Detector>& detector_BackReference);
1157 
1163  OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type::size_type
1164  sizeOfLinkedFilterList () const;
1165 
1171  OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type
1172  getLinkedFilterList () const;
1173 
1181  const std::weak_ptr<ome::xml::model::Filter>&
1182  getLinkedFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type::size_type index) const;
1183 
1194  const std::weak_ptr<ome::xml::model::Filter>&
1195  setLinkedFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, std::weak_ptr>::type::size_type index,
1196  const std::shared_ptr<ome::xml::model::Filter>& filter_BackReference);
1197 
1208  bool
1209  linkFilter (const std::shared_ptr<ome::xml::model::Filter>& filter_BackReference);
1210 
1226  bool
1227  unlinkFilter (const std::shared_ptr<ome::xml::model::Filter>& filter_BackReference);
1228 
1234  OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type::size_type
1235  sizeOfLinkedDichroicList () const;
1236 
1242  OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type
1243  getLinkedDichroicList () const;
1244 
1252  const std::weak_ptr<ome::xml::model::Dichroic>&
1253  getLinkedDichroic (OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type::size_type index) const;
1254 
1265  const std::weak_ptr<ome::xml::model::Dichroic>&
1266  setLinkedDichroic (OMEModelObject::indexed_container<ome::xml::model::Dichroic, std::weak_ptr>::type::size_type index,
1267  const std::shared_ptr<ome::xml::model::Dichroic>& dichroic_BackReference);
1268 
1279  bool
1280  linkDichroic (const std::shared_ptr<ome::xml::model::Dichroic>& dichroic_BackReference);
1281 
1297  bool
1298  unlinkDichroic (const std::shared_ptr<ome::xml::model::Dichroic>& dichroic_BackReference);
1299 
1305  OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type::size_type
1306  sizeOfLinkedLightPathList () const;
1307 
1313  OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type
1314  getLinkedLightPathList () const;
1315 
1323  const std::weak_ptr<ome::xml::model::LightPath>&
1324  getLinkedLightPath (OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type::size_type index) const;
1325 
1336  const std::weak_ptr<ome::xml::model::LightPath>&
1337  setLinkedLightPath (OMEModelObject::indexed_container<ome::xml::model::LightPath, std::weak_ptr>::type::size_type index,
1338  const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
1339 
1350  bool
1351  linkLightPath (const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
1352 
1368  bool
1369  unlinkLightPath (const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
1370 
1376  OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type
1377  sizeOfLinkedROIList () const;
1378 
1384  OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type
1385  getLinkedROIList () const;
1386 
1394  const std::weak_ptr<ome::xml::model::ROI>&
1395  getLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type index) const;
1396 
1407  const std::weak_ptr<ome::xml::model::ROI>&
1408  setLinkedROI (OMEModelObject::indexed_container<ome::xml::model::ROI, std::weak_ptr>::type::size_type index,
1409  const std::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
1410 
1421  bool
1422  linkROI (const std::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
1423 
1439  bool
1440  unlinkROI (const std::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
1441 
1447  OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type::size_type
1448  sizeOfLinkedShapeList () const;
1449 
1455  OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type
1456  getLinkedShapeList () const;
1457 
1465  const std::weak_ptr<ome::xml::model::Shape>&
1466  getLinkedShape (OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type::size_type index) const;
1467 
1478  const std::weak_ptr<ome::xml::model::Shape>&
1479  setLinkedShape (OMEModelObject::indexed_container<ome::xml::model::Shape, std::weak_ptr>::type::size_type index,
1480  const std::shared_ptr<ome::xml::model::Shape>& shape_BackReference);
1481 
1492  bool
1493  linkShape (const std::shared_ptr<ome::xml::model::Shape>& shape_BackReference);
1494 
1510  bool
1511  unlinkShape (const std::shared_ptr<ome::xml::model::Shape>& shape_BackReference);
1512 
1518  OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type::size_type
1519  sizeOfLinkedPlateList () const;
1520 
1526  OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type
1527  getLinkedPlateList () const;
1528 
1536  const std::weak_ptr<ome::xml::model::Plate>&
1537  getLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type::size_type index) const;
1538 
1549  const std::weak_ptr<ome::xml::model::Plate>&
1550  setLinkedPlate (OMEModelObject::indexed_container<ome::xml::model::Plate, std::weak_ptr>::type::size_type index,
1551  const std::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1552 
1563  bool
1564  linkPlate (const std::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1565 
1581  bool
1582  unlinkPlate (const std::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1583 
1589  OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type::size_type
1590  sizeOfLinkedReagentList () const;
1591 
1597  OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type
1598  getLinkedReagentList () const;
1599 
1607  const std::weak_ptr<ome::xml::model::Reagent>&
1608  getLinkedReagent (OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type::size_type index) const;
1609 
1620  const std::weak_ptr<ome::xml::model::Reagent>&
1621  setLinkedReagent (OMEModelObject::indexed_container<ome::xml::model::Reagent, std::weak_ptr>::type::size_type index,
1622  const std::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1623 
1634  bool
1635  linkReagent (const std::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1636 
1652  bool
1653  unlinkReagent (const std::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1654 
1660  OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type::size_type
1661  sizeOfLinkedScreenList () const;
1662 
1668  OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type
1669  getLinkedScreenList () const;
1670 
1678  const std::weak_ptr<ome::xml::model::Screen>&
1679  getLinkedScreen (OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type::size_type index) const;
1680 
1691  const std::weak_ptr<ome::xml::model::Screen>&
1692  setLinkedScreen (OMEModelObject::indexed_container<ome::xml::model::Screen, std::weak_ptr>::type::size_type index,
1693  const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1694 
1705  bool
1706  linkScreen (const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1707 
1723  bool
1724  unlinkScreen (const std::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1725 
1731  OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type::size_type
1732  sizeOfLinkedPlateAcquisitionList () const;
1733 
1739  OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type
1740  getLinkedPlateAcquisitionList () const;
1741 
1749  const std::weak_ptr<ome::xml::model::PlateAcquisition>&
1750  getLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type::size_type index) const;
1751 
1762  const std::weak_ptr<ome::xml::model::PlateAcquisition>&
1763  setLinkedPlateAcquisition (OMEModelObject::indexed_container<ome::xml::model::PlateAcquisition, std::weak_ptr>::type::size_type index,
1764  const std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1765 
1776  bool
1777  linkPlateAcquisition (const std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1778 
1794  bool
1795  unlinkPlateAcquisition (const std::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1796 
1802  OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type::size_type
1803  sizeOfLinkedWellList () const;
1804 
1810  OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type
1811  getLinkedWellList () const;
1812 
1820  const std::weak_ptr<ome::xml::model::Well>&
1821  getLinkedWell (OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type::size_type index) const;
1822 
1833  const std::weak_ptr<ome::xml::model::Well>&
1834  setLinkedWell (OMEModelObject::indexed_container<ome::xml::model::Well, std::weak_ptr>::type::size_type index,
1835  const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
1836 
1847  bool
1848  linkWell (const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
1849 
1865  bool
1866  unlinkWell (const std::shared_ptr<ome::xml::model::Well>& well_BackReference);
1867 
1868  protected:
1869  // Documented in base class.
1870  virtual void
1871  asXMLElementInternal (common::xml::dom::Document& document,
1872  common::xml::dom::Element& element) const;
1873 
1874  public:
1875  // Documented in superclass.
1876  const std::string&
1877  getXMLNamespace() const;
1878  };
1879 
1880  }
1881  }
1882 }
1883 
1884 #endif // OME_XML_MODEL_ANNOTATION_H
1885 
1886 /*
1887  * Local Variables:
1888  * mode:C++
1889  * End:
1890  */
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:1220
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:1156
ome::xml::model::Annotation::getDescription
std::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Annotation.cpp:497
ome::xml::model::Annotation::unlinkLightPath
bool unlinkLightPath(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPath.
Definition: Annotation.cpp:1429
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:646
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:1851
ome::xml::model::Annotation::linkPlane
bool linkPlane(const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Link Plane.
Definition: Annotation.cpp:662
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:1794
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:1348
ome::xml::model::Annotation::operator=
Annotation & operator=(const Annotation &)
Assignment operator (deleted).
ome::xml::model::Annotation::unlinkPlate
bool unlinkPlate(const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Unlink Plate.
Definition: Annotation.cpp:1603
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:530
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:1336
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:1504
ome::xml::model::Annotation::linkChannel
bool linkChannel(const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Link Channel.
Definition: Annotation.cpp:720
ome::xml::model::Annotation::linkExperimenter
bool linkExperimenter(const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Link Experimenter.
Definition: Annotation.cpp:1068
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:634
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:1754
ome::xml::model::Annotation::unlinkFilter
bool unlinkFilter(const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
Unlink Filter.
Definition: Annotation.cpp:1313
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:982
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:594
ome::xml::model::Annotation::setNamespace
void setNamespace(std::shared_ptr< std::string > &namespace_)
Set the Namespace property.
Definition: Annotation.cpp:455
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:1806
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:1638
ome::xml::model::Annotation::unlinkScreen
bool unlinkScreen(const std::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Annotation.cpp:1719
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:994
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:1278
ome::xml::model::Annotation::~Annotation
virtual ~Annotation()
Destructor.
Definition: Annotation.cpp:329
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:1110
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:524
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:1568
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:1214
ome::xml::model::Annotation::linkDataset
bool linkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Annotation.cpp:1010
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:1104
ome::xml::model::Annotation::unlinkFolder
bool unlinkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Unlink Folder.
Definition: Annotation.cpp:1139
ome::xml::model::Annotation::linkProject
bool linkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Annotation.cpp:894
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:1684
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:878
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:820
ome::xml::model::Annotation::linkShape
bool linkShape(const std::shared_ptr< ome::xml::model::Shape > &shape_BackReference)
Link Shape.
Definition: Annotation.cpp:1532
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:1574
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:1040
ome::xml::model::Annotation::linkObjective
bool linkObjective(const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
Link Objective.
Definition: Annotation.cpp:1184
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:1580
ome::xml::model::Annotation::linkReagent
bool linkReagent(const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Link Reagent.
Definition: Annotation.cpp:1648
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:866
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:640
ome::xml::model::Annotation::unlinkDetector
bool unlinkDetector(const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
Unlink Detector.
Definition: Annotation.cpp:1255
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:1748
ome::xml::model::Annotation::linkDichroic
bool linkDichroic(const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
Link Dichroic.
Definition: Annotation.cpp:1358
ome::xml::model::Annotation::unlinkDataset
bool unlinkDataset(const std::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Annotation.cpp:1023
ome::xml::model::Annotation::linkWell
bool linkWell(const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Link Well.
Definition: Annotation.cpp:1822
ome::xml::model::Annotation::unlinkDichroic
bool unlinkDichroic(const std::shared_ptr< ome::xml::model::Dichroic > &dichroic_BackReference)
Unlink Dichroic.
Definition: Annotation.cpp:1371
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:1742
ome::xml::model::Annotation::linkPlateAcquisition
bool linkPlateAcquisition(const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: Annotation.cpp:1764
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:1800
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:588
ome::xml::model::Annotation::linkInstrument
bool linkInstrument(const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Link Instrument.
Definition: Annotation.cpp:778
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:1706
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:750
ome::xml::model::Annotation::unlinkObjective
bool unlinkObjective(const std::shared_ptr< ome::xml::model::Objective > &objective_BackReference)
Unlink Objective.
Definition: Annotation.cpp:1197
ome::xml::model::Annotation::unlinkROI
bool unlinkROI(const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Unlink ROI.
Definition: Annotation.cpp:1487
ome::xml::model::Annotation::linkPlate
bool linkPlate(const std::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Link Plate.
Definition: Annotation.cpp:1590
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:1626
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:698
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:334
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:710
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:942
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:462
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:1562
ome::xml::model::Annotation::unlinkReagent
bool unlinkReagent(const std::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Unlink Reagent.
Definition: Annotation.cpp:1661
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:1510
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:1174
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:1232
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:1458
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:1452
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:1046
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:1272
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:704
ome::xml::model::Annotation::setDescription
void setDescription(std::shared_ptr< std::string > &description)
Set the Description property.
Definition: Annotation.cpp:511
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:826
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:536
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:872
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:1406
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:1620
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:652
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:1522
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:814
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:924
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:1342
ome::xml::model::Annotation::setID
void setID(const std::string &id)
Set the ID property.
Definition: Annotation.cpp:469
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:692
ome::xml::model::Annotation::unlinkImage
bool unlinkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Annotation.cpp:617
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:582
ome::xml::model::Annotation::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: Annotation.cpp:340
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:1516
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:1400
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:411
ome::xml::model::Annotation::unlinkExperimenterGroup
bool unlinkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Annotation.cpp:965
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:1464
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:1388
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:1812
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:576
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:1052
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:1545
ome::xml::model::Annotation::unlinkPlane
bool unlinkPlane(const std::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Unlink Plane.
Definition: Annotation.cpp:675
ome::xml::model::Annotation::unlinkChannel
bool unlinkChannel(const std::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Unlink Channel.
Definition: Annotation.cpp:733
ome::xml::model::Annotation::linkAnnotation
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Annotation.cpp:546
ome::xml::model::Annotation::unlinkExperimenter
bool unlinkExperimenter(const std::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Unlink Experimenter.
Definition: Annotation.cpp:1081
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:762
ome::xml::model::Annotation::linkImage
bool linkImage(const std::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Annotation.cpp:604
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:1116
ome::xml::model::Annotation::unlinkLightSource
bool unlinkLightSource(const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
Unlink LightSource.
Definition: Annotation.cpp:849
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:1168
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:930
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:1696
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:988
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:1736
ome::xml::model::Annotation::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Annotation.cpp:1927
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:884
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:1446
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:1290
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:756
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:808
ome::xml::model::Annotation::linkFilter
bool linkFilter(const std::shared_ptr< ome::xml::model::Filter > &filter_BackReference)
Link Filter.
Definition: Annotation.cpp:1300
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:936
ome::xml::model::Annotation::linkROI
bool linkROI(const std::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Link ROI.
Definition: Annotation.cpp:1474
ome::xml::model::Annotation::Annotation
Annotation()
Default constructor.
Definition: Annotation.cpp:314
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:1226
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:1000
ome::xml::model::Annotation::linkExperimenterGroup
bool linkExperimenterGroup(const std::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Annotation.cpp:952
ome::xml::model::Annotation::getAnnotator
std::shared_ptr< std::string > getAnnotator()
Get the Annotator property.
Definition: Annotation.cpp:476
ome::xml::model::Annotation::getNamespace
std::shared_ptr< std::string > getNamespace()
Get the Namespace property.
Definition: Annotation.cpp:441
ome::xml::model::Annotation::linkFolder
bool linkFolder(const std::shared_ptr< ome::xml::model::Folder > &folder_BackReference)
Link Folder.
Definition: Annotation.cpp:1126
ome::xml::model::Annotation::unlinkWell
bool unlinkWell(const std::shared_ptr< ome::xml::model::Well > &well_BackReference)
Unlink Well.
Definition: Annotation.cpp:1835
ome::xml::model::Annotation::unlinkAnnotation
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Annotation.cpp:559
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:1632
ome::xml::model::Annotation::linkLightPath
bool linkLightPath(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPath.
Definition: Annotation.cpp:1416
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:1330
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:1690
ome::xml::model::Annotation::unlinkPlateAcquisition
bool unlinkPlateAcquisition(const std::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: Annotation.cpp:1777
ome::xml::model::Annotation::unlinkProject
bool unlinkProject(const std::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Annotation.cpp:907
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:1284
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:518
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:768
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:1058
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:1098
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:1394
ome::xml::model::Annotation::setAnnotator
void setAnnotator(std::shared_ptr< std::string > &annotator)
Set the Annotator property.
Definition: Annotation.cpp:490
ome::xml::model::Annotation::linkLightSource
bool linkLightSource(const std::shared_ptr< ome::xml::model::LightSource > &lightSource_BackReference)
Link LightSource.
Definition: Annotation.cpp:836
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:1162
ome::xml::model::Annotation::unlinkInstrument
bool unlinkInstrument(const std::shared_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Unlink Instrument.
Definition: Annotation.cpp:791
ome::xml::model::Annotation::linkDetector
bool linkDetector(const std::shared_ptr< ome::xml::model::Detector > &detector_BackReference)
Link Detector.
Definition: Annotation.cpp:1242
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:1678
Generated on Mon Feb 20 2017 10:34:54 for ome-xml by   doxygen 1.8.13