bioformats  5.1.3
Annotation.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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:
96  ome::compat::shared_ptr<std::string> namespace_;
98  std::string id;
100  ome::compat::shared_ptr<std::string> annotator;
102  ome::compat::shared_ptr<std::string> description;
135 
136  public:
138  Annotation ();
139 
145  Annotation (const Annotation& copy);
146 
148  virtual
149  ~Annotation ();
150 
151 
152 
153  // Documented in superclass.
154  bool
155  validElementName(const std::string& name) const;
156 
157 
158  // -- OMEModelObject API methods --
159 
161  virtual void
162  update(const common::xml::dom::Element& element,
164 
165  public:
166  // -- Annotation API methods --
167 
169  bool
170  link (ome::compat::shared_ptr<Reference>& reference,
171  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
172 
178  ome::compat::shared_ptr<std::string>
179  getNamespace ();
180 
186  const ome::compat::shared_ptr<std::string>
187  getNamespace () const;
188 
194  void
195  setNamespace (ome::compat::shared_ptr<std::string>& namespace_);
196 
202  const std::string&
203  getID () const;
204 
210  void
211  setID (const std::string& id);
212 
218  ome::compat::shared_ptr<std::string>
219  getAnnotator ();
220 
226  const ome::compat::shared_ptr<std::string>
227  getAnnotator () const;
228 
234  void
235  setAnnotator (ome::compat::shared_ptr<std::string>& annotator);
236 
242  ome::compat::shared_ptr<std::string>
243  getDescription ();
244 
250  const ome::compat::shared_ptr<std::string>
251  getDescription () const;
252 
258  void
259  setDescription (ome::compat::shared_ptr<std::string>& description);
260 
268 
275  getLinkedAnnotationList () const;
276 
284  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
286 
297  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
299  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
300 
311  bool
312  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
313 
329  bool
330  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
331 
338  sizeOfLinkedImageList () const;
339 
346  getLinkedImageList () const;
347 
355  const ome::compat::weak_ptr<ome::xml::model::Image>&
357 
368  const ome::compat::weak_ptr<ome::xml::model::Image>&
370  const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
371 
382  bool
383  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
384 
400  bool
401  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image_BackReference);
402 
409  sizeOfLinkedPixelsList () const;
410 
417  getLinkedPixelsList () const;
418 
426  const ome::compat::weak_ptr<ome::xml::model::Pixels>&
428 
439  const ome::compat::weak_ptr<ome::xml::model::Pixels>&
441  const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);
442 
453  bool
454  linkPixels (const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);
455 
471  bool
472  unlinkPixels (const ome::compat::shared_ptr<ome::xml::model::Pixels>& pixels_BackReference);
473 
480  sizeOfLinkedPlaneList () const;
481 
488  getLinkedPlaneList () const;
489 
497  const ome::compat::weak_ptr<ome::xml::model::Plane>&
499 
510  const ome::compat::weak_ptr<ome::xml::model::Plane>&
512  const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
513 
524  bool
525  linkPlane (const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
526 
542  bool
543  unlinkPlane (const ome::compat::shared_ptr<ome::xml::model::Plane>& plane_BackReference);
544 
551  sizeOfLinkedChannelList () const;
552 
559  getLinkedChannelList () const;
560 
568  const ome::compat::weak_ptr<ome::xml::model::Channel>&
570 
581  const ome::compat::weak_ptr<ome::xml::model::Channel>&
583  const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
584 
595  bool
596  linkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
597 
613  bool
614  unlinkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
615 
622  sizeOfLinkedProjectList () const;
623 
630  getLinkedProjectList () const;
631 
639  const ome::compat::weak_ptr<ome::xml::model::Project>&
641 
652  const ome::compat::weak_ptr<ome::xml::model::Project>&
654  const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
655 
666  bool
667  linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
668 
684  bool
685  unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
686 
694 
702 
710  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
712 
723  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
725  const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
726 
737  bool
738  linkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
739 
755  bool
756  unlinkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
757 
764  sizeOfLinkedDatasetList () const;
765 
772  getLinkedDatasetList () const;
773 
781  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
783 
794  const ome::compat::weak_ptr<ome::xml::model::Dataset>&
796  const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
797 
808  bool
809  linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
810 
826  bool
827  unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset_BackReference);
828 
836 
843  getLinkedExperimenterList () const;
844 
852  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
854 
865  const ome::compat::weak_ptr<ome::xml::model::Experimenter>&
867  const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
868 
879  bool
880  linkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
881 
897  bool
898  unlinkExperimenter (const ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter_BackReference);
899 
906  sizeOfLinkedROIList () const;
907 
914  getLinkedROIList () const;
915 
923  const ome::compat::weak_ptr<ome::xml::model::ROI>&
925 
936  const ome::compat::weak_ptr<ome::xml::model::ROI>&
938  const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
939 
950  bool
951  linkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
952 
968  bool
969  unlinkROI (const ome::compat::shared_ptr<ome::xml::model::ROI>& roi_BackReference);
970 
977  sizeOfLinkedPlateList () const;
978 
985  getLinkedPlateList () const;
986 
994  const ome::compat::weak_ptr<ome::xml::model::Plate>&
996 
1007  const ome::compat::weak_ptr<ome::xml::model::Plate>&
1009  const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1010 
1021  bool
1022  linkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1023 
1039  bool
1040  unlinkPlate (const ome::compat::shared_ptr<ome::xml::model::Plate>& plate_BackReference);
1041 
1048  sizeOfLinkedReagentList () const;
1049 
1056  getLinkedReagentList () const;
1057 
1065  const ome::compat::weak_ptr<ome::xml::model::Reagent>&
1067 
1078  const ome::compat::weak_ptr<ome::xml::model::Reagent>&
1080  const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1081 
1092  bool
1093  linkReagent (const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1094 
1110  bool
1111  unlinkReagent (const ome::compat::shared_ptr<ome::xml::model::Reagent>& reagent_BackReference);
1112 
1119  sizeOfLinkedScreenList () const;
1120 
1127  getLinkedScreenList () const;
1128 
1136  const ome::compat::weak_ptr<ome::xml::model::Screen>&
1138 
1149  const ome::compat::weak_ptr<ome::xml::model::Screen>&
1151  const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1152 
1163  bool
1164  linkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1165 
1181  bool
1182  unlinkScreen (const ome::compat::shared_ptr<ome::xml::model::Screen>& screen_BackReference);
1183 
1191 
1199 
1207  const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
1209 
1220  const ome::compat::weak_ptr<ome::xml::model::PlateAcquisition>&
1222  const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1223 
1234  bool
1235  linkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1236 
1252  bool
1253  unlinkPlateAcquisition (const ome::compat::shared_ptr<ome::xml::model::PlateAcquisition>& plateAcquisition_BackReference);
1254 
1261  sizeOfLinkedWellList () const;
1262 
1269  getLinkedWellList () const;
1270 
1278  const ome::compat::weak_ptr<ome::xml::model::Well>&
1280 
1291  const ome::compat::weak_ptr<ome::xml::model::Well>&
1293  const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
1294 
1305  bool
1306  linkWell (const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
1307 
1323  bool
1324  unlinkWell (const ome::compat::shared_ptr<ome::xml::model::Well>& well_BackReference);
1325 
1332  sizeOfLinkedWellSampleList () const;
1333 
1340  getLinkedWellSampleList () const;
1341 
1349  const ome::compat::weak_ptr<ome::xml::model::WellSample>&
1351 
1362  const ome::compat::weak_ptr<ome::xml::model::WellSample>&
1364  const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
1365 
1376  bool
1377  linkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
1378 
1394  bool
1395  unlinkWellSample (const ome::compat::shared_ptr<ome::xml::model::WellSample>& wellSample_BackReference);
1396 
1397 
1400  asXMLElement (common::xml::dom::Document& document) const;
1401 
1402 
1403  protected:
1404  // Documented in base class.
1407  common::xml::dom::Element& element) const;
1408 
1409  public:
1410  // Documented in superclass.
1411  const std::string&
1412  getXMLNamespace() const;
1413  };
1414 
1415  }
1416  }
1417 }
1418 
1419 #endif // OME_XML_MODEL_ANNOTATION_H
1420 
1421 /*
1422  * Local Variables:
1423  * mode:C++
1424  * End:
1425  */
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:1063
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Link Dataset.
Definition: Annotation.cpp:853
ome::compat::shared_ptr< std::string > annotator
Annotator property.
Definition: Annotation.h:100
bool linkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Link PlateAcquisition.
Definition: Annotation.cpp:1201
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type imageLinks
Image_BackReference back reference (occurs more than once)
Definition: Annotation.h:106
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type getLinkedROIList() const
Get the linked ROI list.
Definition: Annotation.cpp:947
ome::compat::shared_ptr< std::string > namespace_
Namespace property.
Definition: Annotation.h:96
bool unlinkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Unlink ROI.
Definition: Annotation.cpp:982
bool linkWell(const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Link Well.
Definition: Annotation.cpp:1259
ome::compat::shared_ptr< std::string > getNamespace()
Get the Namespace property.
Definition: Annotation.cpp:342
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type getLinkedWellList() const
Get the linked Well list.
Definition: Annotation.cpp:1237
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:535
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:547
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:709
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:669
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type wellSampleLinks
WellSample_BackReference back reference (occurs more than once)
Definition: Annotation.h:134
bool unlinkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Unlink WellSample.
Definition: Annotation.cpp:1330
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type getLinkedChannelList() const
Get the linked Channel list.
Definition: Annotation.cpp:657
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:651
bool unlinkPlane(const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Unlink Plane.
Definition: Annotation.cpp:634
bool unlinkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Unlink Screen.
Definition: Annotation.cpp:1156
bool unlinkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Unlink Plate.
Definition: Annotation.cpp:1040
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type experimenterLinks
Experimenter_BackReference back reference (occurs more than once)
Definition: Annotation.h:120
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Annotation.cpp:1471
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:901
OMEModelObject::indexed_container< ome::xml::model::Experimenter, ome::compat::weak_ptr >::type getLinkedExperimenterList() const
Get the linked Experimenter list.
Definition: Annotation.cpp:889
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:883
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset_BackReference)
Unlink Dataset.
Definition: Annotation.cpp:866
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:1127
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:941
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:953
virtual ~Annotation()
Destructor.
Definition: Annotation.cpp:225
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
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:727
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:1301
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:1243
bool linkPixels(const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Link Pixels.
Definition: Annotation.cpp:563
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:1085
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:837
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:785
bool linkWellSample(const ome::compat::shared_ptr< ome::xml::model::WellSample > &wellSample_BackReference)
Link WellSample.
Definition: Annotation.cpp:1317
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:1173
const std::string & getID() const
Get the ID property.
Definition: Annotation.cpp:363
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:477
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:663
bool unlinkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Unlink Channel.
Definition: Annotation.cpp:692
bool linkExperimenter(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Link Experimenter.
Definition: Annotation.cpp:911
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Unlink Image.
Definition: Annotation.cpp:518
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:431
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:611
OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type getLinkedPlaneList() const
Get the linked Plane list.
Definition: Annotation.cpp:599
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type getLinkedScreenList() const
Get the linked Screen list.
Definition: Annotation.cpp:1121
bool linkExperimenterGroup(const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Annotation.cpp:795
bool unlinkWell(const ome::compat::shared_ptr< ome::xml::model::Well > &well_BackReference)
Unlink Well.
Definition: Annotation.cpp:1272
OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type pixelsLinks
Pixels_BackReference back reference (occurs more than once)
Definition: Annotation.h:108
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:593
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Annotation.cpp:447
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: Annotation.h:104
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type getLinkedPlateAcquisitionList() const
Get the linked PlateAcquisition list.
Definition: Annotation.cpp:1179
bool linkScreen(const ome::compat::shared_ptr< ome::xml::model::Screen > &screen_BackReference)
Link Screen.
Definition: Annotation.cpp:1143
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:553
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:1307
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Annotation.cpp:425
bool unlinkExperimenter(const ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter_BackReference)
Unlink Experimenter.
Definition: Annotation.cpp:924
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
bool unlinkReagent(const ome::compat::shared_ptr< ome::xml::model::Reagent > &reagent_BackReference)
Unlink Reagent.
Definition: Annotation.cpp:1098
OMEModelObject::indexed_container< ome::xml::model::Pixels, ome::compat::weak_ptr >::type getLinkedPixelsList() const
Get the linked Pixels list.
Definition: Annotation.cpp:541
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:895
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Annotation.cpp:460
bool linkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Link Channel.
Definition: Annotation.cpp:679
OMEModelObject::indexed_container< ome::xml::model::Well, ome::compat::weak_ptr >::type wellLinks
Well_BackReference back reference (occurs more than once)
Definition: Annotation.h:132
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type datasetLinks
Dataset_BackReference back reference (occurs more than once)
Definition: Annotation.h:118
OMEModelObject::indexed_container< ome::xml::model::Screen, ome::compat::weak_ptr >::type screenLinks
Screen_BackReference back reference (occurs more than once)
Definition: Annotation.h:128
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:773
OMEModelObject::indexed_container< ome::xml::model::PlateAcquisition, ome::compat::weak_ptr >::type plateAcquisitionLinks
PlateAcquisition_BackReference back reference (occurs more than once)
Definition: Annotation.h:130
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:779
bool linkPlane(const ome::compat::shared_ptr< ome::xml::model::Plane > &plane_BackReference)
Link Plane.
Definition: Annotation.cpp:621
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:1069
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type getLinkedPlateList() const
Get the linked Plate list.
Definition: Annotation.cpp:1005
bool linkPlate(const ome::compat::shared_ptr< ome::xml::model::Plate > &plate_BackReference)
Link Plate.
Definition: Annotation.cpp:1027
bool unlinkPixels(const ome::compat::shared_ptr< ome::xml::model::Pixels > &pixels_BackReference)
Unlink Pixels.
Definition: Annotation.cpp:576
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:1354
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Annotation.cpp:715
void setNamespace(ome::compat::shared_ptr< std::string > &namespace_)
Set the Namespace property.
Definition: Annotation.cpp:356
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:1231
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:843
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Annotation.cpp:750
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:1185
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:1011
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type channelLinks
Channel_BackReference back reference (occurs more than once)
Definition: Annotation.h:112
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:489
void setID(const std::string &id)
Set the ID property.
Definition: Annotation.cpp:370
OMEModelObject::indexed_container< ome::xml::model::Plate, ome::compat::weak_ptr >::type plateLinks
Plate_BackReference back reference (occurs more than once)
Definition: Annotation.h:124
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:240
bool unlinkPlateAcquisition(const ome::compat::shared_ptr< ome::xml::model::PlateAcquisition > &plateAcquisition_BackReference)
Unlink PlateAcquisition.
Definition: Annotation.cpp:1214
bool unlinkExperimenterGroup(const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Annotation.cpp:808
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:605
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:825
OMEModelObject::indexed_container< ome::xml::model::ROI, ome::compat::weak_ptr >::type roiLinks
ROI_BackReference back reference (occurs more than once)
Definition: Annotation.h:122
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:495
std::string id
ID property.
Definition: Annotation.h:98
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:1347
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:767
ome::compat::shared_ptr< std::string > getAnnotator()
Get the Annotator property.
Definition: Annotation.cpp:377
ome::compat::shared_ptr< std::string > description
Description property.
Definition: Annotation.h:102
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:1249
OMEModelObject::indexed_container< ome::xml::model::WellSample, ome::compat::weak_ptr >::type getLinkedWellSampleList() const
Get the linked WellSample list.
Definition: Annotation.cpp:1295
void setAnnotator(ome::compat::shared_ptr< std::string > &annotator)
Set the Annotator property.
Definition: Annotation.cpp:391
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Annotation.cpp:231
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:1133
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image_BackReference)
Link Image.
Definition: Annotation.cpp:505
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:437
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Annotation.cpp:412
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:1075
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:419
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:1191
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:1115
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Annotation.cpp:398
OMEModelObject::indexed_container< ome::xml::model::Plane, ome::compat::weak_ptr >::type planeLinks
Plane_BackReference back reference (occurs more than once)
Definition: Annotation.h:110
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Annotation.cpp:483
Annotation()
Default constructor.
Definition: Annotation.cpp:168
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:721
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type projectLinks
Project_BackReference back reference (occurs more than once)
Definition: Annotation.h:114
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:312
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:1289
Boost.Log compatibility.
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:1017
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type experimenterGroupLinks
ExperimenterGroup_BackReference back reference (occurs more than once)
Definition: Annotation.h:116
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Annotation.cpp:831
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Annotation.cpp:737
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:1057
bool linkROI(const ome::compat::shared_ptr< ome::xml::model::ROI > &roi_BackReference)
Link ROI.
Definition: Annotation.cpp:969
Xerces-C modern C++ wrapper.
Definition: Base.h:53
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:959
OMEModelObject::indexed_container< ome::xml::model::Reagent, ome::compat::weak_ptr >::type reagentLinks
Reagent_BackReference back reference (occurs more than once)
Definition: Annotation.h:126
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:999