bioformats  5.1.1
UUID.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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_UUID_H
47 #define OME_XML_MODEL_UUID_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 
64 namespace ome
65 {
66  namespace xml
67  {
68  namespace model
69  {
70 
71  // Forward declarations.
72  class OMEModel;
73 
78  {
79  private:
81  std::string value;
83  ome::compat::shared_ptr<std::string> fileName;
84 
85  public:
87  UUID ();
88 
94  UUID (const UUID& copy);
95 
97  virtual
98  ~UUID ();
99 
100 
101 
116  static ome::compat::shared_ptr< UUID>
117  create(const common::xml::dom::Element& element,
119 
120  // Documented in superclass.
121  const std::string&
122  elementName() const;
123 
124  // Documented in superclass.
125  bool
126  validElementName(const std::string& name) const;
127 
128 
129  // -- OMEModelObject API methods --
130 
132  virtual void
133  update(const common::xml::dom::Element& element,
135 
136  public:
137  // -- UUID API methods --
138 
140  bool
141  link (ome::compat::shared_ptr<Reference>& reference,
142  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
143 
149  const std::string&
150  getValue () const;
151 
157  void
158  setValue (const std::string& value);
159 
165  ome::compat::shared_ptr<std::string>
166  getFileName ();
167 
173  const ome::compat::shared_ptr<std::string>
174  getFileName () const;
175 
181  void
182  setFileName (ome::compat::shared_ptr<std::string>& fileName);
183 
184 
187  asXMLElement (common::xml::dom::Document& document) const;
188 
189 
190  protected:
191  // Documented in base class.
194  common::xml::dom::Element& element) const;
195 
196  public:
197  // Documented in superclass.
198  const std::string&
199  getXMLNamespace() const;
200  };
201 
202  }
203  }
204 }
205 
206 #endif // OME_XML_MODEL_UUID_H
207 
208 /*
209  * Local Variables:
210  * mode:C++
211  * End:
212  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: UUID.cpp:143
ome::compat::shared_ptr< std::string > fileName
FileName property.
Definition: UUID.h:83
std::string value
Element's text data.
Definition: UUID.h:81
virtual ~UUID()
Destructor.
Definition: UUID.cpp:122
DOM Document wrapper.
Definition: Document.h:80
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
UUID model object.
Definition: UUID.h:77
UUID()
Default constructor.
Definition: UUID.cpp:101
void setValue(const std::string &value)
Set element value.
Definition: UUID.cpp:199
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: UUID.cpp:264
static ome::compat::shared_ptr< UUID > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a UUID model object from DOM element.
Definition: UUID.cpp:127
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
void setFileName(ome::compat::shared_ptr< std::string > &fileName)
Set the FileName property.
Definition: UUID.cpp:220
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: UUID.cpp:234
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: UUID.cpp:152
const std::string & getValue() const
Get element value.
Definition: UUID.cpp:193
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: UUID.cpp:227
Boost.Log compatibility.
ome::compat::shared_ptr< std::string > getFileName()
Get the FileName property.
Definition: UUID.cpp:206
const std::string & elementName() const
Get the element name of this model object.
Definition: UUID.cpp:136
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: UUID.cpp:179
Xerces-C modern C++ wrapper.
Definition: Base.h:53