bioformats  5.1.2
Dataset.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_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:
86  ome::compat::shared_ptr<std::string> name;
88  std::string id;
90  ome::compat::shared_ptr<std::string> description;
92  ome::compat::weak_ptr<ome::xml::model::Experimenter> experimenter;
94  ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup> experimenterGroup;
101 
102  public:
104  Dataset ();
105 
111  Dataset (const Dataset& copy);
112 
114  virtual
115  ~Dataset ();
116 
117 
118 
133  static ome::compat::shared_ptr< Dataset>
134  create(const common::xml::dom::Element& element,
136 
137  // Documented in superclass.
138  const std::string&
139  elementName() const;
140 
141  // Documented in superclass.
142  bool
143  validElementName(const std::string& name) const;
144 
145 
146  // -- OMEModelObject API methods --
147 
149  virtual void
150  update(const common::xml::dom::Element& element,
152 
153  public:
154  // -- Dataset API methods --
155 
157  bool
158  link (ome::compat::shared_ptr<Reference>& reference,
159  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
160 
166  ome::compat::shared_ptr<std::string>
167  getName ();
168 
174  const ome::compat::shared_ptr<std::string>
175  getName () const;
176 
182  void
183  setName (ome::compat::shared_ptr<std::string>& name);
184 
190  const std::string&
191  getID () const;
192 
198  void
199  setID (const std::string& id);
200 
206  ome::compat::shared_ptr<std::string>
207  getDescription ();
208 
214  const ome::compat::shared_ptr<std::string>
215  getDescription () const;
216 
222  void
223  setDescription (ome::compat::shared_ptr<std::string>& description);
224 
231  ome::compat::weak_ptr<ome::xml::model::Experimenter>
233 
240  const ome::compat::weak_ptr<ome::xml::model::Experimenter>
241  getLinkedExperimenter () const;
242 
248  void
249  linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
250 
260  void
261  unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
262 
269  ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
271 
278  const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
280 
286  void
287  linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
288 
298  void
299  unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
300 
307  sizeOfLinkedImageList () const;
308 
315  getLinkedImageList () const;
316 
324  const ome::compat::weak_ptr<ome::xml::model::Image>&
326 
337  const ome::compat::weak_ptr<ome::xml::model::Image>&
339  const ome::compat::shared_ptr<ome::xml::model::Image>& image);
340 
351  bool
352  linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image);
353 
369  bool
370  unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image);
371 
379 
386  getLinkedAnnotationList () const;
387 
395  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
397 
408  const ome::compat::weak_ptr<ome::xml::model::Annotation>&
410  const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
411 
422  bool
423  linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
424 
440  bool
441  unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
442 
449  sizeOfLinkedProjectList () const;
450 
457  getLinkedProjectList () const;
458 
466  const ome::compat::weak_ptr<ome::xml::model::Project>&
468 
479  const ome::compat::weak_ptr<ome::xml::model::Project>&
481  const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
482 
493  bool
494  linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
495 
511  bool
512  unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
513 
514 
517  asXMLElement (common::xml::dom::Document& document) const;
518 
519 
520  protected:
521  // Documented in base class.
524  common::xml::dom::Element& element) const;
525 
526  public:
527  // Documented in superclass.
528  const std::string&
529  getXMLNamespace() const;
530  };
531 
532  }
533  }
534 }
535 
536 #endif // OME_XML_MODEL_DATASET_H
537 
538 /*
539  * Local Variables:
540  * mode:C++
541  * End:
542  */
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:498
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Dataset.cpp:454
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Dataset.cpp:512
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dataset.cpp:572
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Dataset.cpp:356
const std::string & elementName() const
Get the element name of this model object.
Definition: Dataset.cpp:172
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:608
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:548
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Dataset.cpp:431
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Dataset.cpp:596
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dataset.cpp:558
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dataset.cpp:784
DOM Document wrapper.
Definition: Document.h:82
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:482
DOM Element wrapper.
Definition: Element.h:66
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Dataset.cpp:370
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Dataset.cpp:618
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:530
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:648
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:602
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:542
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type imageLinks
ImageRef reference (occurs more than once)
Definition: Dataset.h:96
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Dataset.cpp:425
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Dataset.cpp:391
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Dataset.cpp:460
ome::compat::shared_ptr< std::string > description
Description property.
Definition: Dataset.h:90
ome::compat::weak_ptr< ome::xml::model::Experimenter > experimenter
ExperimenterRef reference.
Definition: Dataset.h:92
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:476
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:590
Dataset()
Default constructor.
Definition: Dataset.cpp:125
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:488
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type projectLinks
Project_BackReference back reference (occurs more than once)
Definition: Dataset.h:100
ome::compat::shared_ptr< std::string > name
Name property.
Definition: Dataset.h:86
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:188
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Dataset.cpp:412
const std::string & getID() const
Get the ID property.
Definition: Dataset.cpp:377
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:655
virtual ~Dataset()
Destructor.
Definition: Dataset.cpp:158
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Dataset.cpp:631
Dataset model object.
Definition: Dataset.h:82
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Dataset.cpp:405
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > experimenterGroup
ExperimenterGroupRef reference.
Definition: Dataset.h:94
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
AnnotationRef reference (occurs more than once)
Definition: Dataset.h:98
std::string id
ID property.
Definition: Dataset.h:88
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:287
void setID(const std::string &id)
Set the ID property.
Definition: Dataset.cpp:384
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:163
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dataset.cpp:179
Boost.Log compatibility.
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:470
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dataset.cpp:536
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Dataset.cpp:441
Xerces-C modern C++ wrapper.
Definition: Base.h:53