ome-xml  5.2.0
FileAnnotation.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_FILEANNOTATION_H
47 #define OME_XML_MODEL_FILEANNOTATION_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/BinaryFile.h>
63 #include <ome/xml/model/StructuredAnnotations.h>
64 #include <ome/xml/model/TypeAnnotation.h>
65 
66 namespace ome
67 {
68  namespace xml
69  {
70  namespace model
71  {
72 
73  // Forward declarations.
74  class OMEModel;
75 
80  {
81  private:
82  class Impl;
84  ome::compat::shared_ptr<Impl> impl;
85 
86  public:
89 
95  FileAnnotation (const FileAnnotation& copy);
96 
98  virtual
99  ~FileAnnotation ();
100 
115  static ome::compat::shared_ptr< FileAnnotation>
116  create(const common::xml::dom::Element& element,
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 
128  // -- OMEModelObject API methods --
129 
131  virtual void
132  update(const common::xml::dom::Element& element,
134 
135  public:
136  // -- FileAnnotation API methods --
137 
139  bool
140  link (ome::compat::shared_ptr<Reference>& reference,
141  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
142 
148  ome::compat::shared_ptr<ome::xml::model::BinaryFile>
149  getBinaryFile ();
150 
156  const ome::compat::shared_ptr<ome::xml::model::BinaryFile>
157  getBinaryFile () const;
158 
164  void
165  setBinaryFile (ome::compat::shared_ptr<ome::xml::model::BinaryFile>& binaryFile);
166 
172  ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
174 
180  const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
181  getStructuredAnnotations () const;
182 
188  void
189  setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
190 
191 
194  asXMLElement (common::xml::dom::Document& document) const;
195 
196 
197  protected:
198  // Documented in base class.
201  common::xml::dom::Element& element) const;
202 
203  public:
204  // Documented in superclass.
205  const std::string&
206  getXMLNamespace() const;
207  };
208 
209  }
210  }
211 }
212 
213 #endif // OME_XML_MODEL_FILEANNOTATION_H
214 
215 /*
216  * Local Variables:
217  * mode:C++
218  * End:
219  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< ome::xml::model::BinaryFile > getBinaryFile()
Get the BinaryFile property.
Definition: FileAnnotation.cpp:217
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: FileAnnotation.cpp:294
FileAnnotation()
Default constructor.
Definition: FileAnnotation.cpp:124
void setBinaryFile(ome::compat::shared_ptr< ome::xml::model::BinaryFile > &binaryFile)
Set the BinaryFile property.
Definition: FileAnnotation.cpp:231
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: FileAnnotation.cpp:238
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: FileAnnotation.cpp:252
FileAnnotation model object.
Definition: FileAnnotation.h:79
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: FileAnnotation.cpp:202
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: FileAnnotation.h:82
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: FileAnnotation.cpp:266
Open Microscopy Environment C++ implementation.
const std::string & elementName() const
Get the element name of this model object.
Definition: FileAnnotation.cpp:157
static ome::compat::shared_ptr< FileAnnotation > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a FileAnnotation model object from DOM element.
Definition: FileAnnotation.cpp:148
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: FileAnnotation.cpp:164
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: FileAnnotation.cpp:259
Private implementation details of FileAnnotation model object.
Definition: FileAnnotation.cpp:77
TypeAnnotation model object.
Definition: TypeAnnotation.h:77
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: FileAnnotation.cpp:173
virtual ~FileAnnotation()
Destructor.
Definition: FileAnnotation.cpp:143