ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Experimenter.h>
65 #include <ome/xml/model/ExperimenterGroup.h>
66 #include <ome/xml/model/detail/OMEModelObject.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class Annotation;
77 class Image;
78 class OMEModel;
79 class Project;
80
84 class Dataset : public detail::OMEModelObject
85 {
86 private:
87 class Impl;
89 ome::compat::shared_ptr<Impl> impl;
90
91 public:
93 Dataset();
94
100 Dataset (const Dataset& copy);
101
103 virtual
104 ~Dataset ();
105
120 static ome::compat::shared_ptr< Dataset>
121 create(const common::xml::dom::Element& element,
122 ome::xml::model::OMEModel& model);
123
124 // Documented in superclass.
125 const std::string&
126 elementName() const;
127
128 // Documented in superclass.
129 bool
130 validElementName(const std::string& name) const;
131
132 private:
134 Dataset&
135 operator= (const Dataset&);
136
137 public:
138 // -- OMEModelObject API methods --
139
141 virtual void
142 update(const common::xml::dom::Element& element,
143 ome::xml::model::OMEModel& model);
144
145 public:
146 // -- Dataset API methods --
147
149 bool
150 link (ome::compat::shared_ptr<Reference>& reference,
151 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
152
158 ome::compat::shared_ptr<std::string>
159 getName ();
160
166 const ome::compat::shared_ptr<std::string>
167 getName () const;
168
174 void
175 setName (ome::compat::shared_ptr<std::string>& name);
176
182 const std::string&
183 getID () const;
184
190 void
191 setID (const std::string& id);
192
198 ome::compat::shared_ptr<std::string>
199 getDescription ();
200
206 const ome::compat::shared_ptr<std::string>
207 getDescription () const;
208
214 void
215 setDescription (ome::compat::shared_ptr<std::string>& description);
216
223 ome::compat::weak_ptr<ome::xml::model::Experimenter>
224 getLinkedExperimenter ();
225
232 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
233 getLinkedExperimenter () const;
234
240 void
241 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
242
252 void
253 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
254
261 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
262 getLinkedExperimenterGroup ();
263
270 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
271 getLinkedExperimenterGroup () const;
272
278 void
279 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
280
290 void
291 unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
292
298 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type
299 sizeOfLinkedImageList () const;
300
306 OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type
307 getLinkedImageList () const;
308
316 const ome::compat::weak_ptr<ome::xml::model::Image>&
317 getLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index) const;
318
329 const ome::compat::weak_ptr<ome::xml::model::Image>&
330 setLinkedImage (OMEModelObject::indexed_container<ome::xml::model::Image, ome::compat::weak_ptr>::type::size_type index,
331 const ome::compat::shared_ptr<ome::xml::model::Image>& image);
332
343 bool
344 linkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image);
345
361 bool
362 unlinkImage (const ome::compat::shared_ptr<ome::xml::model::Image>& image);
363
369 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
370 sizeOfLinkedAnnotationList () const;
371
377 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
378 getLinkedAnnotationList () const;
379
387 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
388 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
389
400 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
401 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
402 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
403
414 bool
415 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
416
432 bool
433 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
434
440 OMEModelObject::indexed_container<ome::xml::model::Project, ome::compat::weak_ptr>::type::size_type
441 sizeOfLinkedProjectList () const;
442
448 OMEModelObject::indexed_container<ome::xml::model::Project, ome::compat::weak_ptr>::type
449 getLinkedProjectList () const;
450
458 const ome::compat::weak_ptr<ome::xml::model::Project>&
459 getLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, ome::compat::weak_ptr>::type::size_type index) const;
460
471 const ome::compat::weak_ptr<ome::xml::model::Project>&
472 setLinkedProject (OMEModelObject::indexed_container<ome::xml::model::Project, ome::compat::weak_ptr>::type::size_type index,
473 const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
474
485 bool
486 linkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
487
503 bool
504 unlinkProject (const ome::compat::shared_ptr<ome::xml::model::Project>& project_BackReference);
505
507 virtual common::xml::dom::Element
508 asXMLElement (common::xml::dom::Document& document) const;
509
510
511 protected:
512 // Documented in base class.
513 virtual common::xml::dom::Element
514 asXMLElementInternal (common::xml::dom::Document& document,
515 common::xml::dom::Element& element) const;
516
517 public:
518 // Documented in superclass.
519 const std::string&
520 getXMLNamespace() const;
521 };
522
523 }
524 }
525 }
526
527 #endif // OME_XML_MODEL_DATASET_H
528
529 /*
530 * Local Variables:
531 * mode:C++
532 * End:
533 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Dataset::linkImage
bool linkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Link Image.
Definition: Dataset.cpp:522
ome::xml::model::Dataset::Impl
Private implementation details of Dataset model object.
Definition: Dataset.cpp:79
ome::xml::model::Dataset::linkExperimenterGroup
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Dataset.cpp:478
ome::xml::model::Dataset::unlinkImage
bool unlinkImage(const ome::compat::shared_ptr< ome::xml::model::Image > &image)
Unlink Image.
Definition: Dataset.cpp:536
ome::xml::model::Dataset::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Dataset.cpp:596
ome::xml::model::Dataset::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Dataset.cpp:380
ome::xml::model::Dataset::setLinkedProject
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:632
ome::xml::model::Dataset::getLinkedAnnotation
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:566
ome::xml::model::Dataset::setLinkedAnnotation
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:572
ome::xml::model::Dataset::operator=
Dataset & operator=(const Dataset &)
Assignment operator (deleted).
ome::xml::model::Dataset::unlinkExperimenter
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Dataset.cpp:455
ome::xml::model::Dataset::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Dataset.cpp:582
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Dataset::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Dataset.cpp:394
ome::xml::model::Dataset::linkProject
bool linkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Link Project.
Definition: Dataset.cpp:642
ome::xml::model::Dataset::sizeOfLinkedProjectList
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:614
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Dataset::getLinkedImage
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:506
ome::xml::model::OMEModelObject::indexed_container::type
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
ome::xml::model::Dataset::linkExperimenter
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Dataset.cpp:449
ome::xml::model::Dataset::getLinkedProject
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:626
ome::xml::model::Dataset::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Dataset.h:87
ome::xml::model::Dataset::asXMLElementInternal
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:678
ome::xml::model::Dataset::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Dataset.cpp:415
ome::xml::model::Dataset::unlinkExperimenterGroup
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Dataset.cpp:484
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::xml::model::Dataset::Dataset
Dataset()
Default constructor.
Definition: Dataset.cpp:167
ome::xml::model::Dataset::setLinkedImage
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:512
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Dataset::update
virtual void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Dataset.cpp:211
ome::xml::model::Dataset::getLinkedExperimenter
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Dataset.cpp:436
ome::xml::model::Dataset::getID
const std::string & getID() const
Get the ID property.
Definition: Dataset.cpp:401
ome::xml::model::Dataset::asXMLElement
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:671
ome::xml::model::Dataset::sizeOfLinkedAnnotationList
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:554
ome::xml::model::Dataset::~Dataset
virtual ~Dataset()
Destructor.
Definition: Dataset.cpp:182
ome::xml::model::Dataset::unlinkProject
bool unlinkProject(const ome::compat::shared_ptr< ome::xml::model::Project > &project_BackReference)
Unlink Project.
Definition: Dataset.cpp:655
ome::xml::model::Dataset
Dataset model object.
Definition: Dataset.h:84
ome::xml::model::Dataset::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Dataset.cpp:429
ome::xml::model::Dataset::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Dataset.cpp:560
ome::xml::model::Dataset::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Dataset.cpp:807
ome::xml::model::Dataset::link
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:311
ome::xml::model::Dataset::setID
void setID(const std::string &id)
Set the ID property.
Definition: Dataset.cpp:408
ome::xml::model::Dataset::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Dataset.cpp:196
ome::xml::model::Dataset::create
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:187
ome::xml::model::Dataset::getLinkedProjectList
OMEModelObject::indexed_container< ome::xml::model::Project, ome::compat::weak_ptr >::type getLinkedProjectList() const
Get the linked Project list.
Definition: Dataset.cpp:620
ome::xml::model::Dataset::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Dataset.cpp:203
ome::xml::model::Dataset::getLinkedImageList
OMEModelObject::indexed_container< ome::xml::model::Image, ome::compat::weak_ptr >::type getLinkedImageList() const
Get the linked Image list.
Definition: Dataset.cpp:500
log.h
ome::xml::model::Dataset::getLinkedExperimenterGroup
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Dataset.cpp:465
ome::xml::model::Dataset::sizeOfLinkedImageList
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:494