bioformats  5.1.3
ManufacturerSpec.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_MANUFACTURERSPEC_H
47 #define OME_XML_MODEL_MANUFACTURERSPEC_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  ome::compat::shared_ptr<std::string> lotNumber;
83  ome::compat::shared_ptr<std::string> model;
85  ome::compat::shared_ptr<std::string> serialNumber;
87  ome::compat::shared_ptr<std::string> manufacturer;
88 
89  public:
92 
98  ManufacturerSpec (const ManufacturerSpec& copy);
99 
101  virtual
103 
104 
105 
106  // Documented in superclass.
107  bool
108  validElementName(const std::string& name) const;
109 
110 
111  // -- OMEModelObject API methods --
112 
114  virtual void
115  update(const common::xml::dom::Element& element,
117 
118  public:
119  // -- ManufacturerSpec API methods --
120 
122  bool
123  link (ome::compat::shared_ptr<Reference>& reference,
124  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
125 
131  ome::compat::shared_ptr<std::string>
132  getLotNumber ();
133 
139  const ome::compat::shared_ptr<std::string>
140  getLotNumber () const;
141 
147  void
148  setLotNumber (ome::compat::shared_ptr<std::string>& lotNumber);
149 
155  ome::compat::shared_ptr<std::string>
156  getModel ();
157 
163  const ome::compat::shared_ptr<std::string>
164  getModel () const;
165 
171  void
172  setModel (ome::compat::shared_ptr<std::string>& model);
173 
179  ome::compat::shared_ptr<std::string>
180  getSerialNumber ();
181 
187  const ome::compat::shared_ptr<std::string>
188  getSerialNumber () const;
189 
195  void
196  setSerialNumber (ome::compat::shared_ptr<std::string>& serialNumber);
197 
203  ome::compat::shared_ptr<std::string>
204  getManufacturer ();
205 
211  const ome::compat::shared_ptr<std::string>
212  getManufacturer () const;
213 
219  void
220  setManufacturer (ome::compat::shared_ptr<std::string>& manufacturer);
221 
222 
225  asXMLElement (common::xml::dom::Document& document) const;
226 
227 
228  protected:
229  // Documented in base class.
232  common::xml::dom::Element& element) const;
233 
234  public:
235  // Documented in superclass.
236  const std::string&
237  getXMLNamespace() const;
238  };
239 
240  }
241  }
242 }
243 
244 #endif // OME_XML_MODEL_MANUFACTURERSPEC_H
245 
246 /*
247  * Local Variables:
248  * mode:C++
249  * End:
250  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ManufacturerSpec.cpp:362
void setManufacturer(ome::compat::shared_ptr< std::string > &manufacturer)
Set the Manufacturer property.
Definition: ManufacturerSpec.cpp:285
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: ManufacturerSpec.cpp:144
ome::compat::shared_ptr< std::string > model
Model property.
Definition: ManufacturerSpec.h:83
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: ManufacturerSpec.cpp:292
ManufacturerSpec()
Default constructor.
Definition: ManufacturerSpec.cpp:104
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
void setSerialNumber(ome::compat::shared_ptr< std::string > &serialNumber)
Set the SerialNumber property.
Definition: ManufacturerSpec.cpp:264
ome::compat::shared_ptr< std::string > serialNumber
SerialNumber property.
Definition: ManufacturerSpec.h:85
void setModel(ome::compat::shared_ptr< std::string > &model)
Set the Model property.
Definition: ManufacturerSpec.cpp:243
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ManufacturerSpec.cpp:135
ome::compat::shared_ptr< std::string > getLotNumber()
Get the LotNumber property.
Definition: ManufacturerSpec.cpp:208
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
virtual ~ManufacturerSpec()
Destructor.
Definition: ManufacturerSpec.cpp:129
void setLotNumber(ome::compat::shared_ptr< std::string > &lotNumber)
Set the LotNumber property.
Definition: ManufacturerSpec.cpp:222
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: ManufacturerSpec.cpp:193
ome::compat::shared_ptr< std::string > getManufacturer()
Get the Manufacturer property.
Definition: ManufacturerSpec.cpp:271
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: ManufacturerSpec.cpp:299
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
ome::compat::shared_ptr< std::string > lotNumber
LotNumber property.
Definition: ManufacturerSpec.h:81
ome::compat::shared_ptr< std::string > getModel()
Get the Model property.
Definition: ManufacturerSpec.cpp:229
ome::compat::shared_ptr< std::string > manufacturer
Manufacturer property.
Definition: ManufacturerSpec.h:87
Boost.Log compatibility.
ome::compat::shared_ptr< std::string > getSerialNumber()
Get the SerialNumber property.
Definition: ManufacturerSpec.cpp:250
Xerces-C modern C++ wrapper.
Definition: Base.h:53