ome-xml  5.2.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 #include <ome/common/xml/dom/NodeList.h>
61 
62 #include <ome/xml/model/detail/OMEModelObject.h>
63 
64 namespace ome
65 {
66  namespace xml
67  {
68  namespace model
69  {
70 
71  // Forward declarations.
72  class Channel;
73  class Dataset;
74  class Experimenter;
75  class ExperimenterGroup;
76  class Image;
77  class OMEModel;
78  class Pixels;
79  class Plane;
80  class Plate;
81  class PlateAcquisition;
82  class Project;
83  class ROI;
84  class Reagent;
85  class Screen;
86  class Well;
87  class WellSample;
88 
93  {
94  private:
95  class Impl;
97  ome::compat::shared_ptr<Impl> impl;
98 
99  public:
101  Annotation();
102 
108  Annotation (const Annotation& copy);
109 
111  virtual
112  ~Annotation ();
113 
114 
115  // Documented in superclass.
116  bool
117  validElementName(const std::string& name) const;
118 
119 
120  // -- OMEModelObject API methods --
121 
123  virtual void
124  update(const common::xml::dom::Element& element,
126 
127  public:
128  // -- Annotation API methods --
129 
131  bool
132  link (ome::compat::shared_ptr<Reference>& reference,
133  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
134 
140  ome::compat::shared_ptr<std::string>
141  getNamespace ();
142 
148  const ome::compat::shared_ptr<std::string>
149  getNamespace () const;
150 
156  void
157  setNamespace (ome::compat::shared_ptr<std::string>& namespace_);
158 
164  const std::string&
165  getID () const;
166 
172  void
173  setID (const std::string& id);
174 
180  ome::compat::shared_ptr<std::string>
181  getAnnotator ();
182 
188  const ome::compat::shared_ptr<std::string>
189  getAnnotator () const;
190 
196  void
197  setAnnotator (ome::compat::shared_ptr<std::string>& annotator);
198 
204  ome::compat::shared_ptr<std::string>
205  getDescription ();
206 
212  const ome::compat::shared_ptr<std::string>
213  getDescription () const;
214 
220  void
221  setDescription (ome::compat::shared_ptr<std::string>& description);
222 
230 
237  getLinkedAnnotationList () const;
238 
246  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
248 
259  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
261  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
262 
273  bool
274  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
275 
291  bool
292  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
293 
300  sizeOfLinkedImageList () const;
301 
308  getLinkedImageList () const;
309 
317  const ome::compat::weak_ptr<ome::xml::model::Image>&
319 
330  const ome::compat::weak_ptr<ome::xml::model::Image>&
332  const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
333 
344  bool
345  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
346 
362  bool
363  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
364 
371  sizeOfLinkedPixelsList () const;
372 
379  getLinkedPixelsList () const;
380 
388  const ome::compat::weak_ptr<ome::xml::model::Pixels>&
390 
401  const ome::compat::weak_ptr<ome::xml::model::Pixels>&
403  const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);
404 
415  bool
416  linkPixels (const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);
417 
433  bool
434  unlinkPixels (const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);
435 
442  sizeOfLinkedPlaneList () const;
443 
450  getLinkedPlaneList () const;
451 
459  const ome::compat::weak_ptr<ome::xml::model::Plane>&
461 
472  const ome::compat::weak_ptr<ome::xml::model::Plane>&
474  const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
475 
486  bool
487  linkPlane (const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
488 
504  bool
505  unlinkPlane (const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
506 
513  sizeOfLinkedChannelList () const;
514 
521  getLinkedChannelList () const;
522 
530  const ome::compat::weak_ptr<ome::xml::model::Channel>&
532 
543  const ome::compat::weak_ptr<ome::xml::model::Channel>&
545  const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
546 
557  bool
558  linkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
559 
575  bool
576  unlinkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
577 
584  sizeOfLinkedProjectList () const;
585 
592  getLinkedProjectList () const;
593 
601  const ome::compat::weak_ptr<ome::xml::model::Project>&
603 
614  const ome::compat::weak_ptr<ome::xml::model::Project>&
616  const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
617 
628  bool
629  linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
630 
646  bool
647  unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
648 
656 
664 
672  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
674 
685  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
687  const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
688 
699  bool
700  linkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
701 
717  bool
718  unlinkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
719 
726  sizeOfLinkedDatasetList () const;
727 
734  getLinkedDatasetList () const;
735 
743  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
745 
756  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
758  const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
759 
770  bool
771  linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
772 
788  bool
789  unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
790 
798 
805  getLinkedExperimenterList () const;
806 
814  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
816 
827  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
829  const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
830 
841  bool
842  linkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
843 
859  bool
860  unlinkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
861 
868  sizeOfLinkedROIList () const;
869 
876  getLinkedROIList () const;
877 
885  const ome::compat::weak_ptr<ome::xml::model::ROI>&
887 
898  const ome::compat::weak_ptr<ome::xml::model::ROI>&
900  const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
901 
912  bool
913  linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
914 
930  bool
931  unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
932 
939  sizeOfLinkedPlateList () const;
940 
947  getLinkedPlateList () const;
948 
956  const ome::compat::weak_ptr<ome::xml::model::Plate>&
958 
969  const ome::compat::weak_ptr<ome::xml::model::Plate>&
971  const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
972 
983  bool
984  linkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
985 
1001  bool
1002  unlinkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1003 
1010  sizeOfLinkedReagentList () const;
1011 
1018  getLinkedReagentList () const;
1019 
1027  const ome::compat::weak_ptr<ome::xml::model::Reagent>&
1029 
1040  const ome::compat::weak_ptr<ome::xml::model::Reagent>&
1042  const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1043 
1054  bool
1055  linkReagent (const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1056 
1072  bool
1073  unlinkReagent (const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1074 
1081  sizeOfLinkedScreenList () const;
1082 
1089  getLinkedScreenList () const;
1090 
1098  const ome::compat::weak_ptr<ome::xml::model::Screen>&
1100 
1111  const ome::compat::weak_ptr<ome::xml::model::Screen>&
1113  const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1114 
1125  bool
1126  linkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1127 
1143  bool
1144  unlinkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1145 
1153 
1161 
1169  const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
1171 
1182  const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
1184  const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1185 
1196  bool
1197  linkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1198 
1214  bool
1215  unlinkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1216 
1223  sizeOfLinkedWellList () const;
1224 
1231  getLinkedWellList () const;
1232 
1240  const ome::compat::weak_ptr<ome::xml::model::Well>&
1242 
1253  const ome::compat::weak_ptr<ome::xml::model::Well>&
1255  const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
1256 
1267  bool
1268  linkWell (const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
1269 
1285  bool
1286  unlinkWell (const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
1287 
1294  sizeOfLinkedWellSampleList () const;
1295 
1302  getLinkedWellSampleList () const;
1303 
1311  const ome::compat::weak_ptr<ome::xml::model::WellSample>&
1313 
1324  const ome::compat::weak_ptr<ome::xml::model::WellSample>&
1326  const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
1327 
1338  bool
1339  linkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
1340 
1356  bool
1357  unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
1358 
1359 
1362  asXMLElement (common::xml::dom::Document& document) const;
1363 
1364 
1365  protected:
1366  // Documented in base class.
1369  common::xml::dom::Element& element) const;
1370 
1371  public:
1372  // Documented in superclass.
1373  const std::string&
1374  getXMLNamespace() const;
1375  };
1376 
1377  }
1378  }
1379 }
1380 
1381 #endif // OME_XML_MODEL_ANNOTATION_H
1382 
1383 /*
1384  * Local Variables:
1385  * mode:C++
1386  * End:
1387  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type getLinkedReagentList() const
Get the linked Reagent list.
Definition: Annotation.cpp:1116
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Annotation.cpp:906
bool linkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: Annotation.cpp:1254
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Annotation.cpp:1000
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Unlink ROI.
Definition: Annotation.cpp:1035
bool linkWell(const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Link Well.
Definition: Annotation.cpp:1312
ome::compat::shared_ptr< std::string > getNamespace()
Get the Namespace property.
Definition: Annotation.cpp:395
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type getLinkedWellList() const
Get the linked Well list.
Definition: Annotation.cpp:1290
OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPixelsList() const
Get size of linked Pixels list.
Definition: Annotation.cpp:588
const ome::compat::weak_ptr< ome::xml::model::Pixels > & getLinkedPixels(OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type::size_type index) const
Get linked Pixels.
Definition: Annotation.cpp:600
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: Annotation.cpp:762
const ome::compat::weak_ptr< ome::xml::model::Channel > & setLinkedChannel(OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Set linked Channel.
Definition: Annotation.cpp:722
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Annotation.cpp:1383
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type getLinkedChannelList() const
Get the linked Channel list.
Definition: Annotation.cpp:710
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type sizeOfLinkedChannelList() const
Get size of linked Channel list.
Definition: Annotation.cpp:704
bool unlinkPlane(const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Unlink Plane.
Definition: Annotation.cpp:687
bool unlinkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Annotation.cpp:1209
bool unlinkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Unlink Plate.
Definition: Annotation.cpp:1093
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Annotation.cpp:1494
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & setLinkedExperimenter(OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Set linked Experimenter.
Definition: Annotation.cpp:954
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type getLinkedExperimenterList() const
Get the linked Experimenter list.
Definition: Annotation.cpp:942
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExperimenterList() const
Get size of linked Experimenter list.
Definition: Annotation.cpp:936
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Annotation.cpp:919
const ome::compat::weak_ptr< ome::xml::model::Screen > & getLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index) const
Get linked Screen.
Definition: Annotation.cpp:1180
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type sizeOfLinkedROIList() const
Get size of linked ROI list.
Definition: Annotation.cpp:994
const ome::compat::weak_ptr< ome::xml::model::ROI > & getLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index) const
Get linked ROI.
Definition: Annotation.cpp:1006
virtual ~Annotation()
Destructor.
Definition: Annotation.cpp:278
const ome::compat::weak_ptr< ome::xml::model::Project > & setLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Set linked Project.
Definition: Annotation.cpp:780
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
const ome::compat::weak_ptr< ome::xml::model::WellSample > & getLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index) const
Get linked WellSample.
Definition: Annotation.cpp:1354
const ome::compat::weak_ptr< ome::xml::model::Well > & getLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type index) const
Get linked Well.
Definition: Annotation.cpp:1296
bool linkPixels(const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Link Pixels.
Definition: Annotation.cpp:616
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 > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
bool linkReagent(const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Link Reagent.
Definition: Annotation.cpp:1138
const ome::compat::weak_ptr< ome::xml::model::Dataset > & getLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index) const
Get linked Dataset.
Definition: Annotation.cpp:890
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > & setLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Set linked ExperimenterGroup.
Definition: Annotation.cpp:838
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Annotation.cpp:1370
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateAcquisitionList() const
Get size of linked PlateAcquisition list.
Definition: Annotation.cpp:1226
const std::string & getID() const
Get the ID property.
Definition: Annotation.cpp:416
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Annotation.cpp:530
const ome::compat::weak_ptr< ome::xml::model::Channel > & getLinkedChannel(OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type index) const
Get linked Channel.
Definition: Annotation.cpp:716
bool unlinkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Unlink Channel.
Definition: Annotation.cpp:745
bool linkExperimenter(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Link Experimenter.
Definition: Annotation.cpp:964
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Annotation.cpp:571
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Annotation.cpp:484
const ome::compat::weak_ptr< ome::xml::model::Plane > & setLinkedPlane(OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Set linked Plane.
Definition: Annotation.cpp:664
OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type getLinkedPlaneList() const
Get the linked Plane list.
Definition: Annotation.cpp:652
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type getLinkedScreenList() const
Get the linked Screen list.
Definition: Annotation.cpp:1174
bool linkExperimenterGroup(const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Annotation.cpp:848
bool unlinkWell(const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Unlink Well.
Definition: Annotation.cpp:1325
OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlaneList() const
Get size of linked Plane list.
Definition: Annotation.cpp:646
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Annotation.cpp:500
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type getLinkedPlateAcquisitionList() const
Get the linked PlateAcquisition list.
Definition: Annotation.cpp:1232
bool linkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Link Screen.
Definition: Annotation.cpp:1196
const ome::compat::weak_ptr< ome::xml::model::Pixels > & setLinkedPixels(OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Set linked Pixels.
Definition: Annotation.cpp:606
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
const ome::compat::weak_ptr< ome::xml::model::WellSample > & setLinkedWellSample(OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Set linked WellSample.
Definition: Annotation.cpp:1360
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Annotation.cpp:478
bool unlinkExperimenter(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Unlink Experimenter.
Definition: Annotation.cpp:977
Open Microscopy Environment C++ implementation.
bool unlinkReagent(const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Unlink Reagent.
Definition: Annotation.cpp:1151
OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type getLinkedPixelsList() const
Get the linked Pixels list.
Definition: Annotation.cpp:594
const ome::compat::weak_ptr< ome::xml::model::Experimenter > & getLinkedExperimenter(OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type::size_type index) const
Get linked Experimenter.
Definition: Annotation.cpp:948
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Annotation.cpp:513
bool linkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Link Channel.
Definition: Annotation.cpp:732
Annotation model object.
Definition: Annotation.h:92
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type getLinkedExperimenterGroupList() const
Get the linked ExperimenterGroup list.
Definition: Annotation.cpp:826
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > & getLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type index) const
Get linked ExperimenterGroup.
Definition: Annotation.cpp:832
bool linkPlane(const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Link Plane.
Definition: Annotation.cpp:674
const ome::compat::weak_ptr< ome::xml::model::Reagent > & getLinkedReagent(OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type::size_type index) const
Get linked Reagent.
Definition: Annotation.cpp:1122
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type getLinkedPlateList() const
Get the linked Plate list.
Definition: Annotation.cpp:1058
bool linkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Link Plate.
Definition: Annotation.cpp:1080
bool unlinkPixels(const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Unlink Pixels.
Definition: Annotation.cpp:629
virtual common::xml::dom::Element asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: Annotation.cpp:1407
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Annotation.cpp:768
void setNamespace(ome::compat::shared_ptr< std::string > &namespace_)
Set the Namespace property.
Definition: Annotation.cpp:409
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellList() const
Get size of linked Well list.
Definition: Annotation.cpp:1284
const ome::compat::weak_ptr< ome::xml::model::Dataset > & setLinkedDataset(OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Set linked Dataset.
Definition: Annotation.cpp:896
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Annotation.cpp:803
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & getLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index) const
Get linked PlateAcquisition.
Definition: Annotation.cpp:1238
const ome::compat::weak_ptr< ome::xml::model::Plate > & getLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type index) const
Get linked Plate.
Definition: Annotation.cpp:1064
const ome::compat::weak_ptr< ome::xml::model::Image > & getLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index) const
Get linked Image.
Definition: Annotation.cpp:542
void setID(const std::string &id)
Set the ID property.
Definition: Annotation.cpp:423
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:293
bool unlinkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: Annotation.cpp:1267
bool unlinkExperimenterGroup(const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Annotation.cpp:861
const ome::compat::weak_ptr< ome::xml::model::Plane > & getLinkedPlane(OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type::size_type index) const
Get linked Plane.
Definition: Annotation.cpp:658
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Annotation.cpp:878
const ome::compat::weak_ptr< ome::xml::model::Image > & setLinkedImage(OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Set linked Image.
Definition: Annotation.cpp:548
Private implementation details of Annotation model object.
Definition: Annotation.cpp:86
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Annotation.cpp:1400
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: Annotation.cpp:820
ome::compat::shared_ptr< std::string > getAnnotator()
Get the Annotator property.
Definition: Annotation.cpp:430
const ome::compat::weak_ptr< ome::xml::model::Well > & setLinkedWell(OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Set linked Well.
Definition: Annotation.cpp:1302
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Annotation.cpp:1348
void setAnnotator(ome::compat::shared_ptr< std::string > &annotator)
Set the Annotator property.
Definition: Annotation.cpp:444
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Annotation.cpp:284
const ome::compat::weak_ptr< ome::xml::model::Screen > & setLinkedScreen(OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Set linked Screen.
Definition: Annotation.cpp:1186
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Annotation.cpp:558
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Annotation.cpp:490
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Annotation.cpp:465
const ome::compat::weak_ptr< ome::xml::model::Reagent > & setLinkedReagent(OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Set linked Reagent.
Definition: Annotation.cpp:1128
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Annotation.cpp:472
const ome::compat::weak_ptr< ome::xml::model::PlateAcquisition > & setLinkedPlateAcquisition(OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Set linked PlateAcquisition.
Definition: Annotation.cpp:1244
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type::size_type sizeOfLinkedScreenList() const
Get size of linked Screen list.
Definition: Annotation.cpp:1168
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Annotation.cpp:451
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Annotation.cpp:536
Annotation()
Default constructor.
Definition: Annotation.cpp:259
const ome::compat::weak_ptr< ome::xml::model::Project > & getLinkedProject(OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type index) const
Get linked Project.
Definition: Annotation.cpp:774
bool link(ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Annotation.cpp:365
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type::size_type sizeOfLinkedWellSampleList() const
Get size of linked WellSample list.
Definition: Annotation.cpp:1342
const ome::compat::weak_ptr< ome::xml::model::Plate > & setLinkedPlate(OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Set linked Plate.
Definition: Annotation.cpp:1070
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Annotation.cpp:884
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Annotation.h:95
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Annotation.cpp:790
OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type::size_type sizeOfLinkedReagentList() const
Get size of linked Reagent list.
Definition: Annotation.cpp:1110
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Link ROI.
Definition: Annotation.cpp:1022
const ome::compat::weak_ptr< ome::xml::model::ROI > & setLinkedROI(OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Set linked ROI.
Definition: Annotation.cpp:1012
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type::size_type sizeOfLinkedPlateList() const
Get size of linked Plate list.
Definition: Annotation.cpp:1052