ome-xml 5.2.3

Rights.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_RIGHTS_H
47 #define OME_XML_MODEL_RIGHTS_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/detail/OMEModelObject.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class OMEModel;
75
79 class Rights : public detail::OMEModelObject
80 {
81 private:
82 class Impl;
84 ome::compat::shared_ptr<Impl> impl;
85
86 public:
88 Rights();
89
95 Rights (const Rights& copy);
96
98 virtual
99 ~Rights ();
100
115 static ome::compat::shared_ptr< Rights>
116 create(const common::xml::dom::Element& element,
117 ome::xml::model::OMEModel& model);
118
119 // Documented in superclass.
120 const std::string&
121 elementName() const;
122
123 // Documented in superclass.
124 bool
125 validElementName(const std::string& name) const;
126
127 private:
129 Rights&
130 operator= (const Rights&);
131
132 public:
133 // -- OMEModelObject API methods --
134
136 virtual void
137 update(const common::xml::dom::Element& element,
138 ome::xml::model::OMEModel& model);
139
140 public:
141 // -- Rights API methods --
142
144 bool
145 link (ome::compat::shared_ptr<Reference>& reference,
146 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
147
153 ome::compat::shared_ptr<std::string>
154 getRightsHolder ();
155
161 const ome::compat::shared_ptr<std::string>
162 getRightsHolder () const;
163
169 void
170 setRightsHolder (ome::compat::shared_ptr<std::string>& rightsHolder);
171
177 ome::compat::shared_ptr<std::string>
178 getRightsHeld ();
179
185 const ome::compat::shared_ptr<std::string>
186 getRightsHeld () const;
187
193 void
194 setRightsHeld (ome::compat::shared_ptr<std::string>& rightsHeld);
195
197 virtual common::xml::dom::Element
198 asXMLElement (common::xml::dom::Document& document) const;
199
200
201 protected:
202 // Documented in base class.
203 virtual common::xml::dom::Element
204 asXMLElementInternal (common::xml::dom::Document& document,
205 common::xml::dom::Element& element) const;
206
207 public:
208 // Documented in superclass.
209 const std::string&
210 getXMLNamespace() const;
211 };
212
213 }
214 }
215 }
216
217 #endif // OME_XML_MODEL_RIGHTS_H
218
219 /*
220 * Local Variables:
221 * mode:C++
222 * End:
223 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Rights::getRightsHolder
ome::compat::shared_ptr< std::string > getRightsHolder()
Get the RightsHolder property.
Definition: Rights.cpp:219
ome::xml::model::Rights
Rights model object.
Definition: Rights.h:79
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::Rights::getRightsHeld
ome::compat::shared_ptr< std::string > getRightsHeld()
Get the RightsHeld property.
Definition: Rights.cpp:240
ome::xml::model::Rights::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Rights.cpp:152
ome::xml::model::Rights::create
static ome::compat::shared_ptr< Rights > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Rights model object from DOM element.
Definition: Rights.cpp:136
ome::xml::model::Rights::Rights
Rights()
Default constructor.
Definition: Rights.cpp:116
ome::xml::model::Rights::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Rights.cpp:145
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Rights::setRightsHolder
void setRightsHolder(ome::compat::shared_ptr< std::string > &rightsHolder)
Set the RightsHolder property.
Definition: Rights.cpp:233
ome::xml::model::Rights::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: Rights.cpp:160
ome::xml::model::Rights::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: Rights.cpp:204
ome::xml::model::Rights::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Rights.h:82
ome::xml::model::Rights::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: Rights.cpp:267
ome::xml::model::Rights::setRightsHeld
void setRightsHeld(ome::compat::shared_ptr< std::string > &rightsHeld)
Set the RightsHeld property.
Definition: Rights.cpp:254
ome::xml::model::Rights::Impl
Private implementation details of Rights model object.
Definition: Rights.cpp:70
ome::xml::model::Rights::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Rights.cpp:260
log.h
ome::xml::model::Rights::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Rights.cpp:312
ome::xml::model::Rights::~Rights
virtual ~Rights()
Destructor.
Definition: Rights.cpp:131
ome::xml::model::Rights::operator=
Rights & operator=(const Rights &)
Assignment operator (deleted).