ome-xml  5.2.0
Dataset.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_DATASET_H
47 #define OME_XML_MODEL_DATASET_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/Experimenter.h>
63 #include <ome/xml/model/ExperimenterGroup.h>
64 #include <ome/xml/model/detail/OMEModelObject.h>
65 
66 namespace ome
67 {
68  namespace xml
69  {
70  namespace model
71  {
72 
73  // Forward declarations.
74  class Annotation;
75  class Image;
76  class OMEModel;
77  class Project;
78 
83  {
84  private:
85  class Impl;
87  ome::compat::shared_ptr<Impl> impl;
88 
89  public:
91  Dataset();
92 
98  Dataset (const Dataset& copy);
99 
101  virtual
102  ~Dataset ();
103 
118  static ome::compat::shared_ptr< Dataset>
119  create(const common::xml::dom::Element& element,
121 
122  // Documented in superclass.
123  const std::string&
124  elementName() const;
125 
126  // Documented in superclass.
127  bool
128  validElementName(const std::string& name) const;
129 
130 
131  // -- OMEModelObject API methods --
132 
134  virtual void
135  update(const common::xml::dom::Element& element,
137 
138  public:
139  // -- Dataset API methods --
140 
142  bool
143  link (ome::compat::shared_ptr<Reference>& reference,
144  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
145 
151  ome::compat::shared_ptr<std::string>
152  getName ();
153 
159  const ome::compat::shared_ptr<std::string>
160  getName () const;
161 
167  void
168  setName (ome::compat::shared_ptr<std::string>& name);
169 
175  const std::string&
176  getID () const;
177 
183  void
184  setID (const std::string& id);
185 
191  ome::compat::shared_ptr<std::string>
192  getDescription ();
193 
199  const ome::compat::shared_ptr<std::string>
200  getDescription () const;
201 
207  void
208  setDescription (ome::compat::shared_ptr<std::string>& description);
209 
216  ome::compat::weak_ptr<ome::xml::model::Experimenter>
218 
225  const ome::compat::weak_ptr<ome::xml::model::Experimenter>
226  getLinkedExperimenter () const;
227 
233  void
234  linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
235 
245  void
246  unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
247 
254  ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
256 
263  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
265 
271  void
272  linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
273 
283  void
284  unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
285 
292  sizeOfLinkedImageList () const;
293 
300  getLinkedImageList () const;
301 
309  const ome::compat::weak_ptr<ome::xml::model::Image>&
311 
322  const ome::compat::weak_ptr<ome::xml::model::Image>&
324  const ome::compat::shared_ptr<ome::xml::model::Image>& image);
325 
336  bool
337  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image);
338 
354  bool
355  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image);
356 
364 
371  getLinkedAnnotationList () const;
372 
380  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
382 
393  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
395  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
396 
407  bool
408  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
409 
425  bool
426  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
427 
434  sizeOfLinkedProjectList () const;
435 
442  getLinkedProjectList () const;
443 
451  const ome::compat::weak_ptr<ome::xml::model::Project>&
453 
464  const ome::compat::weak_ptr<ome::xml::model::Project>&
466  const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
467 
478  bool
479  linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
480 
496  bool
497  unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
498 
499 
502  asXMLElement (common::xml::dom::Document& document) const;
503 
504 
505  protected:
506  // Documented in base class.
509  common::xml::dom::Element& element) const;
510 
511  public:
512  // Documented in superclass.
513  const std::string&
514  getXMLNamespace() const;
515  };
516 
517  }
518  }
519 }
520 
521 #endif // OME_XML_MODEL_DATASET_H
522 
523 /*
524  * Local Variables:
525  * mode:C++
526  * End:
527  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: Dataset.cpp:527
Private implementation details of Dataset model object.
Definition: Dataset.cpp:79
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Dataset.cpp:483
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Dataset.cpp:541
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dataset.cpp:601
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Dataset.cpp:385
const std::string & elementName() const
Get the element name of this model object.
Definition: Dataset.cpp:201
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: Dataset.cpp:637
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: Dataset.cpp:577
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Dataset.cpp:460
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Dataset.cpp:625
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dataset.cpp:587
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dataset.cpp:813
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: Dataset.cpp:511
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Dataset.cpp:399
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Dataset.cpp:647
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Dataset.cpp:559
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
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Dataset.cpp:677
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: Dataset.cpp:631
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: Dataset.cpp:571
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Dataset.cpp:454
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Dataset.h:85
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Dataset.cpp:420
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Dataset.cpp:489
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Dataset.cpp:505
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type::size_type sizeOfLinkedProjectList() const
Get size of linked Project list.
Definition: Dataset.cpp:619
Dataset()
Default constructor.
Definition: Dataset.cpp:168
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)
Set linked Image.
Definition: Dataset.cpp:517
Open Microscopy Environment C++ implementation.
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: Dataset.cpp:217
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Dataset.cpp:441
const std::string & getID() const
Get the ID property.
Definition: Dataset.cpp:406
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: Dataset.cpp:684
virtual ~Dataset()
Destructor.
Definition: Dataset.cpp:187
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Dataset.cpp:660
Dataset model object.
Definition: Dataset.h:82
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Dataset.cpp:434
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: Dataset.cpp:316
void setID(const std::string &id)
Set the ID property.
Definition: Dataset.cpp:413
static ome::compat::shared_ptr< Dataset > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Dataset model object from DOM element.
Definition: Dataset.cpp:192
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dataset.cpp:208
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type::size_type sizeOfLinkedImageList() const
Get size of linked Image list.
Definition: Dataset.cpp:499
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dataset.cpp:565
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Dataset.cpp:470