ome-xml  5.6.0
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 
61 #include <ome/xml/model/primitives/Quantity.h>
62 
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class OMEModel;
74 
79  {
80  private:
81  class Impl;
83  std::shared_ptr<Impl> impl;
84 
85  public:
87  Rights();
88 
94  Rights (const Rights& copy);
95 
97  virtual
98  ~Rights ();
99 
114  static std::shared_ptr<Rights>
115  create(const common::xml::dom::Element& element,
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 
127  Rights&
128  operator= (const Rights&) = delete;
130 
131  // -- OMEModelObject API methods --
132 
134  virtual void
135  update(const common::xml::dom::Element& element,
137 
138  public:
139  // -- Rights API methods --
140 
142  bool
143  link (std::shared_ptr<Reference>& reference,
144  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
145 
151  std::shared_ptr<std::string>
152  getRightsHolder ();
153 
159  const std::shared_ptr<std::string>
160  getRightsHolder () const;
161 
167  void
168  setRightsHolder (std::shared_ptr<std::string>& rightsHolder);
169 
175  std::shared_ptr<std::string>
176  getRightsHeld ();
177 
183  const std::shared_ptr<std::string>
184  getRightsHeld () const;
185 
191  void
192  setRightsHeld (std::shared_ptr<std::string>& rightsHeld);
193 
194  protected:
195  // Documented in base class.
196  virtual void
198  common::xml::dom::Element& element) const;
199 
200  public:
201  // Documented in superclass.
202  const std::string&
203  getXMLNamespace() const;
204  };
205 
206  }
207  }
208 }
209 
210 #endif // OME_XML_MODEL_RIGHTS_H
211 
212 /*
213  * Local Variables:
214  * mode:C++
215  * End:
216  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
std::shared_ptr< std::string > getRightsHeld()
Get the RightsHeld property.
Definition: Rights.cpp:246
Rights model object.
Definition: Rights.h:78
virtual void 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:266
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
std::shared_ptr< std::string > getRightsHolder()
Get the RightsHolder property.
Definition: Rights.cpp:225
void setRightsHolder(std::shared_ptr< std::string > &rightsHolder)
Set the RightsHolder property.
Definition: Rights.cpp:239
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Rights.cpp:160
Rights()
Default constructor.
Definition: Rights.cpp:120
const std::string & elementName() const
Get the element name of this model object.
Definition: Rights.cpp:153
Open Microscopy Environment C++ implementation.
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Rights.h:81
virtual SKIP 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:166
void setRightsHeld(std::shared_ptr< std::string > &rightsHeld)
Set the RightsHeld property.
Definition: Rights.cpp:260
static std::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:144
Private implementation details of Rights model object.
Definition: Rights.cpp:70
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Rights.cpp:309
virtual ~Rights()
Destructor.
Definition: Rights.cpp:139
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Rights.cpp:210