ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

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/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 Dataset;
76 class OMEModel;
77
81 class Project : public detail::OMEModelObject
82 {
83 private:
84 class Impl;
86 ome::compat::shared_ptr<Impl> impl;
87
88 public:
90 Project();
91
97 Project (const Project& copy);
98
100 virtual
101 ~Project ();
102
117 static ome::compat::shared_ptr< Project>
118 create(const common::xml::dom::Element& element,
119 ome::xml::model::OMEModel& model);
120
121 // Documented in superclass.
122 const std::string&
123 elementName() const;
124
125 // Documented in superclass.
126 bool
127 validElementName(const std::string& name) const;
128
129
130 // -- OMEModelObject API methods --
131
133 virtual void
134 update(const common::xml::dom::Element& element,
135 ome::xml::model::OMEModel& model);
136
137 public:
138 // -- Project API methods --
139
141 bool
142 link (ome::compat::shared_ptr<Reference>& reference,
143 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144
150 ome::compat::shared_ptr<std::string>
151 getName ();
152
158 const ome::compat::shared_ptr<std::string>
159 getName () const;
160
166 void
167 setName (ome::compat::shared_ptr<std::string>& name);
168
174 const std::string&
175 getID () const;
176
182 void
183 setID (const std::string& id);
184
190 ome::compat::shared_ptr<std::string>
191 getDescription ();
192
198 const ome::compat::shared_ptr<std::string>
199 getDescription () const;
200
206 void
207 setDescription (ome::compat::shared_ptr<std::string>& description);
208
215 ome::compat::weak_ptr<ome::xml::model::Experimenter>
216 getLinkedExperimenter ();
217
224 const ome::compat::weak_ptr<ome::xml::model::Experimenter>
225 getLinkedExperimenter () const;
226
232 void
233 linkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
234
244 void
245 unlinkExperimenter (ome::compat::shared_ptr<ome::xml::model::Experimenter>& experimenter);
246
253 ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
254 getLinkedExperimenterGroup ();
255
262 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>
263 getLinkedExperimenterGroup () const;
264
270 void
271 linkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
272
282 void
283 unlinkExperimenterGroup (ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup);
284
290 OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type
291 sizeOfLinkedDatasetList () const;
292
298 OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type
299 getLinkedDatasetList () const;
300
308 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
309 getLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type index) const;
310
321 const ome::compat::weak_ptr<ome::xml::model::Dataset>&
322 setLinkedDataset (OMEModelObject::indexed_container<ome::xml::model::Dataset, ome::compat::weak_ptr>::type::size_type index,
323 const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
324
335 bool
336 linkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
337
353 bool
354 unlinkDataset (const ome::compat::shared_ptr<ome::xml::model::Dataset>& dataset);
355
361 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
362 sizeOfLinkedAnnotationList () const;
363
369 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
370 getLinkedAnnotationList () const;
371
379 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
380 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
381
392 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
393 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
394 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
395
406 bool
407 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
408
424 bool
425 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
426
427
429 virtual common::xml::dom::Element
430 asXMLElement (common::xml::dom::Document& document) const;
431
432
433 protected:
434 // Documented in base class.
435 virtual common::xml::dom::Element
436 asXMLElementInternal (common::xml::dom::Document& document,
437 common::xml::dom::Element& element) const;
438
439 public:
440 // Documented in superclass.
441 const std::string&
442 getXMLNamespace() const;
443 };
444
445 }
446 }
447 }
448
449 #endif // OME_XML_MODEL_PROJECT_H
450
451 /*
452 * Local Variables:
453 * mode:C++
454 * End:
455 */
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:81
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:503
ome::xml::model::Project::unlinkExperimenter
void unlinkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Unlink Experimenter.
Definition: Project.cpp:452
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:200
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:551
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:509
ome::xml::model::Project::setName
void setName(ome::compat::shared_ptr< std::string > &name)
Set the Name property.
Definition: Project.cpp:391
ome::xml::model::Project::getName
ome::compat::shared_ptr< std::string > getName()
Get the Name property.
Definition: Project.cpp:377
ome::xml::model::Project::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Project.cpp:745
ome::xml::model::Project::linkExperimenterGroup
void linkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Link ExperimenterGroup.
Definition: Project.cpp:475
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:491
ome::xml::model::Project::linkExperimenter
void linkExperimenter(ome::compat::shared_ptr< ome::xml::model::Experimenter > &experimenter)
Link Experimenter.
Definition: Project.cpp:446
ome::xml::model::Project::getID
const std::string & getID() const
Get the ID property.
Definition: Project.cpp:398
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::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:184
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:308
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:209
ome::xml::model::Project::unlinkExperimenterGroup
void unlinkExperimenterGroup(ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup)
Unlink ExperimenterGroup.
Definition: Project.cpp:481
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:611
ome::xml::model::Project::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Project.h:84
ome::xml::model::Project::setID
void setID(const std::string &id)
Set the ID property.
Definition: Project.cpp:405
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:160
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:519
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:618
ome::xml::model::Project::setDescription
void setDescription(ome::compat::shared_ptr< std::string > &description)
Set the Description property.
Definition: Project.cpp:426
ome::xml::model::Project::~Project
virtual ~Project()
Destructor.
Definition: Project.cpp:179
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:569
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:563
ome::xml::model::Project::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Project.cpp:193
ome::xml::model::Project::getLinkedExperimenter
ome::compat::weak_ptr< ome::xml::model::Experimenter > getLinkedExperimenter()
Get linked Experimenter.
Definition: Project.cpp:433
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:497
ome::xml::model::Project::getDescription
ome::compat::shared_ptr< std::string > getDescription()
Get the Description property.
Definition: Project.cpp:412
ome::xml::model::Project::unlinkDataset
bool unlinkDataset(const ome::compat::shared_ptr< ome::xml::model::Dataset > &dataset)
Unlink Dataset.
Definition: Project.cpp:533
ome::xml::model::Project::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Project.cpp:593
log.h
ome::xml::model::Project::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Project.cpp:579
ome::xml::model::Project::getLinkedExperimenterGroup
ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > getLinkedExperimenterGroup()
Get linked ExperimenterGroup.
Definition: Project.cpp:462
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:557