ome-xml  5.2.0
External.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_EXTERNAL_H
47 #define OME_XML_MODEL_EXTERNAL_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/detail/OMEModelObject.h>
63 #include <ome/xml/model/enums/Compression.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  ome::compat::shared_ptr<Impl> impl;
84 
85  public:
87  External();
88 
94  External (const External& copy);
95 
97  virtual
98  ~External ();
99 
114  static ome::compat::shared_ptr< External>
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 
126 
127  // -- OMEModelObject API methods --
128 
130  virtual void
131  update(const common::xml::dom::Element& element,
133 
134  public:
135  // -- External 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  gethref () const;
149 
155  void
156  sethref (const std::string& href);
157 
163  ome::compat::shared_ptr<ome::xml::model::enums::Compression>
164  getCompression ();
165 
171  const ome::compat::shared_ptr<ome::xml::model::enums::Compression>
172  getCompression () const;
173 
179  void
180  setCompression (ome::compat::shared_ptr<ome::xml::model::enums::Compression>& compression);
181 
187  const std::string&
188  getSHA1 () const;
189 
195  void
196  setSHA1 (const std::string& sha1);
197 
198 
201  asXMLElement (common::xml::dom::Document& document) const;
202 
203 
204  protected:
205  // Documented in base class.
208  common::xml::dom::Element& element) const;
209 
210  public:
211  // Documented in superclass.
212  const std::string&
213  getXMLNamespace() const;
214  };
215 
216  }
217  }
218 }
219 
220 #endif // OME_XML_MODEL_EXTERNAL_H
221 
222 /*
223  * Local Variables:
224  * mode:C++
225  * End:
226  */
External model object.
Definition: External.h:78
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
static ome::compat::shared_ptr< External > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a External model object from DOM element.
Definition: External.cpp:149
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: External.cpp:324
const std::string & elementName() const
Get the element name of this model object.
Definition: External.cpp:158
ome::compat::shared_ptr< ome::xml::model::enums::Compression > getCompression()
Get the Compression property.
Definition: External.cpp:237
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
const std::string & gethref() const
Get the href property.
Definition: External.cpp:223
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: External.cpp:208
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: External.cpp:165
Open Microscopy Environment C++ implementation.
External()
Default constructor.
Definition: External.cpp:125
void setCompression(ome::compat::shared_ptr< ome::xml::model::enums::Compression > &compression)
Set the Compression property.
Definition: External.cpp:251
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: External.h:81
void sethref(const std::string &href)
Set the href property.
Definition: External.cpp:230
void setSHA1(const std::string &sha1)
Set the SHA1 property.
Definition: External.cpp:265
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: External.cpp:272
virtual ~External()
Destructor.
Definition: External.cpp:144
const std::string & getSHA1() const
Get the SHA1 property.
Definition: External.cpp:258
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: External.cpp:279
Private implementation details of External model object.
Definition: External.cpp:71
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: External.cpp:174