ome-xml 5.2.0

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

- File List

Leader.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_LEADER_H
47 #define OME_XML_MODEL_LEADER_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/Reference.h>
63
64 namespace ome
65 {
66 namespace xml
67 {
68 namespace model
69 {
70
71 // Forward declarations.
72 class ExperimenterGroup;
73 class OMEModel;
74
78 class Leader : public Reference
79 {
80 private:
81 class Impl;
83 ome::compat::shared_ptr<Impl> impl;
84
85 public:
87 Leader();
88
94 Leader (const Leader& copy);
95
97 virtual
98 ~Leader ();
99
114 static ome::compat::shared_ptr< Leader>
115 create(const common::xml::dom::Element& element,
116 ome::xml::model::OMEModel& model);
117
118 // Documented in superclass.
119 const std::string&
120 elementName() const;
121
122 // Documented in superclass.
123 bool
124 validElementName(const std::string& name) const;
125
126
127 // -- OMEModelObject API methods --
128
130 virtual void
131 update(const common::xml::dom::Element& element,
132 ome::xml::model::OMEModel& model);
133
134 public:
135 // -- Leader API methods --
136
138 bool
139 link (ome::compat::shared_ptr<Reference>& reference,
140 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
141
147 const std::string&
148 getID () const;
149
155 void
156 setID (const std::string& id);
157
163 OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr>::type::size_type
164 sizeOfLinkedExperimenterGroupList () const;
165
171 OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr>::type
172 getLinkedExperimenterGroupList () const;
173
181 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
182 getLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr>::type::size_type index) const;
183
194 const ome::compat::weak_ptr<ome::xml::model::ExperimenterGroup>&
195 setLinkedExperimenterGroup (OMEModelObject::indexed_container<ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr>::type::size_type index,
196 const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
197
208 bool
209 linkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
210
226 bool
227 unlinkExperimenterGroup (const ome::compat::shared_ptr<ome::xml::model::ExperimenterGroup>& experimenterGroup_BackReference);
228
229
231 virtual common::xml::dom::Element
232 asXMLElement (common::xml::dom::Document& document) const;
233
234
235 protected:
236 // Documented in base class.
237 virtual common::xml::dom::Element
238 asXMLElementInternal (common::xml::dom::Document& document,
239 common::xml::dom::Element& element) const;
240
241 public:
242 // Documented in superclass.
243 const std::string&
244 getXMLNamespace() const;
245 };
246
247 }
248 }
249 }
250
251 #endif // OME_XML_MODEL_LEADER_H
252
253 /*
254 * Local Variables:
255 * mode:C++
256 * End:
257 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Leader::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Leader.cpp:151
ome::xml::model::Leader::create
static ome::compat::shared_ptr< Leader > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Leader model object from DOM element.
Definition: Leader.cpp:142
ome::xml::model::Leader::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Leader.h:81
ome::xml::model::Leader::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Leader.cpp:158
ome::xml::model::Leader::getLinkedExperimenterGroup
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > & getLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type index) const
Get linked ExperimenterGroup.
Definition: Leader.cpp:235
ome::xml::model::Leader::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: Leader.cpp:167
ome::xml::model::Leader::unlinkExperimenterGroup
bool unlinkExperimenterGroup(const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Unlink ExperimenterGroup.
Definition: Leader.cpp:264
ome::xml::model::Leader::Leader
Leader()
Default constructor.
Definition: Leader.cpp:118
ome::xml::model::Leader::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Leader.cpp:314
ome::xml::model::Leader::setLinkedExperimenterGroup
const ome::compat::weak_ptr< ome::xml::model::ExperimenterGroup > & setLinkedExperimenterGroup(OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Set linked ExperimenterGroup.
Definition: Leader.cpp:241
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Leader::~Leader
virtual ~Leader()
Destructor.
Definition: Leader.cpp:137
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::Leader::Impl
Private implementation details of Leader model object.
Definition: Leader.cpp:71
ome::xml::model::Leader::sizeOfLinkedExperimenterGroupList
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExperimenterGroupList() const
Get size of linked ExperimenterGroup list.
Definition: Leader.cpp:223
ome::xml::model::Leader
Leader model object.
Definition: Leader.h:78
ome::xml::model::Leader::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Leader.cpp:281
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Leader::linkExperimenterGroup
bool linkExperimenterGroup(const ome::compat::shared_ptr< ome::xml::model::ExperimenterGroup > &experimenterGroup_BackReference)
Link ExperimenterGroup.
Definition: Leader.cpp:251
ome::xml::model::Leader::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: Leader.cpp:288
ome::xml::model::Leader::getID
const std::string & getID() const
Get the ID property.
Definition: Leader.cpp:209
ome::xml::model::Leader::setID
void setID(const std::string &id)
Set the ID property.
Definition: Leader.cpp:216
ome::xml::model::Reference
Reference model object.
Definition: Reference.h:77
ome::xml::model::Leader::getLinkedExperimenterGroupList
OMEModelObject::indexed_container< ome::xml::model::ExperimenterGroup, ome::compat::weak_ptr >::type getLinkedExperimenterGroupList() const
Get the linked ExperimenterGroup list.
Definition: Leader.cpp:229
log.h
ome::xml::model::Leader::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: Leader.cpp:194