ome-xml 5.2.0

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

- File List

BinaryOnly.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_BINARYONLY_H
47 #define OME_XML_MODEL_BINARYONLY_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
77 class BinaryOnly : public detail::OMEModelObject
78 {
79 private:
80 class Impl;
82 ome::compat::shared_ptr<Impl> impl;
83
84 public:
86 BinaryOnly();
87
93 BinaryOnly (const BinaryOnly& copy);
94
96 virtual
97 ~BinaryOnly ();
98
113 static ome::compat::shared_ptr< BinaryOnly>
114 create(const common::xml::dom::Element& element,
115 ome::xml::model::OMEModel& model);
116
117 // Documented in superclass.
118 const std::string&
119 elementName() const;
120
121 // Documented in superclass.
122 bool
123 validElementName(const std::string& name) const;
124
125
126 // -- OMEModelObject API methods --
127
129 virtual void
130 update(const common::xml::dom::Element& element,
131 ome::xml::model::OMEModel& model);
132
133 public:
134 // -- BinaryOnly API methods --
135
137 bool
138 link (ome::compat::shared_ptr<Reference>& reference,
139 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
140
146 const std::string&
147 getMetadataFile () const;
148
154 void
155 setMetadataFile (const std::string& metadataFile);
156
162 const std::string&
163 getUUID () const;
164
170 void
171 setUUID (const std::string& uuid);
172
173
175 virtual common::xml::dom::Element
176 asXMLElement (common::xml::dom::Document& document) const;
177
178
179 protected:
180 // Documented in base class.
181 virtual common::xml::dom::Element
182 asXMLElementInternal (common::xml::dom::Document& document,
183 common::xml::dom::Element& element) const;
184
185 public:
186 // Documented in superclass.
187 const std::string&
188 getXMLNamespace() const;
189 };
190
191 }
192 }
193 }
194
195 #endif // OME_XML_MODEL_BINARYONLY_H
196
197 /*
198 * Local Variables:
199 * mode:C++
200 * End:
201 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::BinaryOnly
BinaryOnly model object.
Definition: BinaryOnly.h:77
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::BinaryOnly::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: BinaryOnly.cpp:151
ome::xml::model::BinaryOnly::create
static ome::compat::shared_ptr< BinaryOnly > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a BinaryOnly model object from DOM element.
Definition: BinaryOnly.cpp:142
ome::xml::model::BinaryOnly::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: BinaryOnly.cpp:237
ome::xml::model::BinaryOnly::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: BinaryOnly.cpp:277
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::BinaryOnly::getMetadataFile
const std::string & getMetadataFile() const
Get the MetadataFile property.
Definition: BinaryOnly.cpp:209
ome::xml::model::BinaryOnly::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: BinaryOnly.cpp:167
ome::xml::model::BinaryOnly::setUUID
void setUUID(const std::string &uuid)
Set the UUID property.
Definition: BinaryOnly.cpp:230
ome::xml::model::BinaryOnly::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: BinaryOnly.h:80
ome::xml::model::BinaryOnly::Impl
Private implementation details of BinaryOnly model object.
Definition: BinaryOnly.cpp:71
ome::xml::model::BinaryOnly::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: BinaryOnly.cpp:244
ome::xml::model::BinaryOnly::~BinaryOnly
virtual ~BinaryOnly()
Destructor.
Definition: BinaryOnly.cpp:137
ome::xml::model::BinaryOnly::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: BinaryOnly.cpp:158
ome::xml::model::BinaryOnly::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: BinaryOnly.cpp:194
ome::xml::model::BinaryOnly::getUUID
const std::string & getUUID() const
Get the UUID property.
Definition: BinaryOnly.cpp:223
ome::xml::model::BinaryOnly::setMetadataFile
void setMetadataFile(const std::string &metadataFile)
Set the MetadataFile property.
Definition: BinaryOnly.cpp:216
log.h
ome::xml::model::BinaryOnly::BinaryOnly
BinaryOnly()
Default constructor.
Definition: BinaryOnly.cpp:118