ome-xml 5.2.3

Project.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_PROJECT_H
47 #define OME_XML_MODEL_PROJECT_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 Dataset;
78 class OMEModel;
79
83 class Project : public detail::OMEModelObject
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 Project();
93
99 Project (const Project& copy);
100
102 virtual
103 ~Project ();
104
119 static ome::compat::shared_ptr< Project>
120 create(const common::xml::dom::Element& element,
121 ome::xml::model::OMEModel& model);
122
123 // Documented in superclass.
124 const std::string&
125 elementName() const;
126
127 // Documented in superclass.
128 bool
129 validElementName(const std::string& name) const;
130
131 private:
133 Project&
134 operator= (const Project&);
135
136 public:
137 // -- OMEModelObject API methods --
138
140 virtual void
141 update(const common::xml::dom::Element& element,
142 ome::xml::model::OMEModel& model);
143
144 public:
145 // -- Project API methods --
146
148 bool
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
151
157 ome::compat::shared_ptr<std::string>
158 getName ();
159
165 const ome::compat::shared_ptr<std::string>
166 getName () const;
167
173 void
174 setName (ome::compat::shared_ptr<std::string>& name);
175
181 const std::string&
182 getID () const;
183
189 void
190 setID (const std::string& id);
191
197 ome::compat::shared_ptr<std::string>
198 getDescription ();
199
205 const ome::compat::shared_ptr<std::string>
206 getDescription () const;
207
213 void
214 setDescription (ome::compat::shared_ptr<std::string>& description);
215
222 ome::compat::weak_ptr<ome::xml::model::Experimenter>
223 getLinkedExperimenter ();
224
231 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
232 getLinkedExperimenter () const;
233
239 void
240 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
241
251 void
252 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
253
260 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
261 getLinkedExperimenterGroup ();
262
269 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
270 getLinkedExperimenterGroup () const;
271
277 void
278 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
279
289 void
290 unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
291
297 OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type
298 sizeOfLinkedDatasetList () const;
299
305 OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type
306 getLinkedDatasetList () const;
307
315 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
316 getLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type index) const;
317
328 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
329 setLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type index,
330 const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
331
342 bool
343 linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
344
360 bool
361 unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
362
368 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
369 sizeOfLinkedAnnotationList () const;
370
376 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
377 getLinkedAnnotationList () const;
378
386 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
387 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
388
399 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
400 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
401 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
402
413 bool
414 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
415
431 bool
432 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
433
435 virtual common::xml::dom::Element
436 asXMLElement (common::xml::dom::Document& document) const;
437
438
439 protected:
440 // Documented in base class.
441 virtual common::xml::dom::Element
442 asXMLElementInternal (common::xml::dom::Document& document,
443 common::xml::dom::Element& element) const;
444
445 public:
446 // Documented in superclass.
447 const std::string&
448 getXMLNamespace() const;
449 };
450
451 }
452 }
453 }
454
455 #endif // OME_XML_MODEL_PROJECT_H
456
457 /*
458 * Local Variables:
459 * mode:C++
460 * End:
461 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Project
Project model object.
Definition: Project.h:83
ome::xml::model::Project::unlinkExperimenter
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Project.cpp:447
ome::xml::model::Project::setLinkedDataset
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)
Set linked Dataset.
Definition: Project.cpp:504
ome::xml::model::Project::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Project.cpp:386
ome::xml::model::Project::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Project.cpp:372
ome::xml::model::Project::linkExperimenterGroup
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Project.cpp:470
ome::xml::model::Project::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Project.cpp:546
ome::xml::model::Project::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Project.cpp:605
ome::xml::model::Project::operator=
Project & operator=(const Project &)
Assignment operator (deleted).
ome::xml::model::Project::linkExperimenter
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Project.cpp:441
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Project::getLinkedDataset
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: Project.cpp:498
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::Project::create
static ome::compat::shared_ptr< Project > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Project model object from DOM element.
Definition: Project.cpp:179
ome::xml::model::Project::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Project.cpp:195
ome::xml::model::Project::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: Project.cpp:303
ome::xml::model::Project::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: Project.cpp:203
ome::xml::model::Project::unlinkExperimenterGroup
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Project.cpp:476
ome::xml::model::Project::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Project.cpp:739
ome::xml::model::Project::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Project.h:86
ome::xml::model::Project::sizeOfLinkedDatasetList
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type::size_type sizeOfLinkedDatasetList() const
Get size of linked Dataset list.
Definition: Project.cpp:486
ome::xml::model::Project::setID
void setID(const std::string &id)
Set the ID property.
Definition: Project.cpp:400
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::Project::Project
Project()
Default constructor.
Definition: Project.cpp:159
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Project::linkDataset
bool linkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Link Dataset.
Definition: Project.cpp:514
ome::xml::model::Project::getID
const std::string & getID() const
Get the ID property.
Definition: Project.cpp:393
ome::xml::model::Project::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Project.cpp:421
ome::xml::model::Project::~Project
virtual ~Project()
Destructor.
Definition: Project.cpp:174
ome::xml::model::Project::Impl
Private implementation details of Project model object.
Definition: Project.cpp:78
ome::xml::model::Project::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: Project.cpp:564
ome::xml::model::Project::getLinkedDatasetList
OMEModelObject::indexed_container< ome::xml::model::Dataset, ome::compat::weak_ptr >::type getLinkedDatasetList() const
Get the linked Dataset list.
Definition: Project.cpp:492
ome::xml::model::Project::getLinkedExperimenter
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Project.cpp:428
ome::xml::model::Project::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Project.cpp:407
ome::xml::model::Project::unlinkDataset
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Unlink Dataset.
Definition: Project.cpp:528
ome::xml::model::Project::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Project.cpp:188
ome::xml::model::Project::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: Project.cpp:558
ome::xml::model::Project::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Project.cpp:588
ome::xml::model::Project::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Project.cpp:552
ome::xml::model::Project::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Project.cpp:574
ome::xml::model::Project::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: Project.cpp:612
log.h
ome::xml::model::Project::getLinkedExperimenterGroup
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Project.cpp:457