bioformats  5.1.3
FileAnnotation.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_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:
83  ome::compat::shared_ptr<ome::xml::model::BinaryFile> binaryFile;
85  ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations> structuredAnnotations;
86 
87  public:
89  FileAnnotation ();
90 
96  FileAnnotation (const FileAnnotation& copy);
97 
99  virtual
100  ~FileAnnotation ();
101 
102 
103 
118  static ome::compat::shared_ptr< FileAnnotation>
119  create(const common::xml::dom::Element& element,
121 
122  // Documented in superclass.
123  const std::string&
124  elementName() const;
125 
126  // Documented in superclass.
127  bool
128  validElementName(const std::string& name) const;
129 
130 
131  // -- OMEModelObject API methods --
132 
134  virtual void
135  update(const common::xml::dom::Element& element,
137 
138  public:
139  // -- FileAnnotation API methods --
140 
142  bool
143  link (ome::compat::shared_ptr<Reference>& reference,
144  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
145 
151  ome::compat::shared_ptr<ome::xml::model::BinaryFile>
152  getBinaryFile ();
153 
159  const ome::compat::shared_ptr<ome::xml::model::BinaryFile>
160  getBinaryFile () const;
161 
167  void
168  setBinaryFile (ome::compat::shared_ptr<ome::xml::model::BinaryFile>& binaryFile);
169 
175  ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
177 
183  const ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>
184  getStructuredAnnotations () const;
185 
191  void
192  setStructuredAnnotations (ome::compat::weak_ptr<ome::xml::model::StructuredAnnotations>& structuredAnnotations_BackReference);
193 
194 
197  asXMLElement (common::xml::dom::Document& document) const;
198 
199 
200  protected:
201  // Documented in base class.
204  common::xml::dom::Element& element) const;
205 
206  public:
207  // Documented in superclass.
208  const std::string&
209  getXMLNamespace() const;
210  };
211 
212  }
213  }
214 }
215 
216 #endif // OME_XML_MODEL_FILEANNOTATION_H
217 
218 /*
219  * Local Variables:
220  * mode:C++
221  * End:
222  */
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:200
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: FileAnnotation.cpp:277
FileAnnotation()
Default constructor.
Definition: FileAnnotation.cpp:105
void setBinaryFile(ome::compat::shared_ptr< ome::xml::model::BinaryFile > &binaryFile)
Set the BinaryFile property.
Definition: FileAnnotation.cpp:214
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > getStructuredAnnotations()
Get the StructuredAnnotations property.
Definition: FileAnnotation.cpp:221
void setStructuredAnnotations(ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > &structuredAnnotations_BackReference)
Set the StructuredAnnotations property.
Definition: FileAnnotation.cpp:235
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
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:185
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:249
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
const std::string & elementName() const
Get the element name of this model object.
Definition: FileAnnotation.cpp:140
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:131
ome::compat::shared_ptr< ome::xml::model::BinaryFile > binaryFile
BinaryFile property.
Definition: FileAnnotation.h:83
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: FileAnnotation.cpp:147
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:242
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:156
ome::compat::weak_ptr< ome::xml::model::StructuredAnnotations > structuredAnnotations
StructuredAnnotations_BackReference back reference.
Definition: FileAnnotation.h:85
Boost.Log compatibility.
virtual ~FileAnnotation()
Destructor.
Definition: FileAnnotation.cpp:126
Xerces-C modern C++ wrapper.
Definition: Base.h:53