ome-xml  5.6.0
ManufacturerSpec.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_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 
61 #include <ome/xml/model/primitives/Quantity.h>
62 
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 
65 namespace ome
66 {
67  namespace xml
68  {
69  namespace model
70  {
71 
72  // Forward declarations.
73  class OMEModel;
74 
79  {
80  private:
81  class Impl;
83  std::shared_ptr<Impl> impl;
84 
85  public:
88 
94  ManufacturerSpec (const ManufacturerSpec& copy);
95 
97  virtual
99 
100  // Documented in superclass.
101  bool
102  validElementName(const std::string& name) const;
103 
106  operator= (const ManufacturerSpec&) = delete;
108 
109  // -- OMEModelObject API methods --
110 
112  virtual void
113  update(const common::xml::dom::Element& element,
115 
116  public:
117  // -- ManufacturerSpec API methods --
118 
120  bool
121  link (std::shared_ptr<Reference>& reference,
122  std::shared_ptr<ome::xml::model::OMEModelObject>& object);
123 
129  std::shared_ptr<std::string>
130  getLotNumber ();
131 
137  const std::shared_ptr<std::string>
138  getLotNumber () const;
139 
145  void
146  setLotNumber (std::shared_ptr<std::string>& lotNumber);
147 
153  std::shared_ptr<std::string>
154  getModel ();
155 
161  const std::shared_ptr<std::string>
162  getModel () const;
163 
169  void
170  setModel (std::shared_ptr<std::string>& model);
171 
177  std::shared_ptr<std::string>
178  getSerialNumber ();
179 
185  const std::shared_ptr<std::string>
186  getSerialNumber () const;
187 
193  void
194  setSerialNumber (std::shared_ptr<std::string>& serialNumber);
195 
201  std::shared_ptr<std::string>
202  getManufacturer ();
203 
209  const std::shared_ptr<std::string>
210  getManufacturer () const;
211 
217  void
218  setManufacturer (std::shared_ptr<std::string>& manufacturer);
219 
220  protected:
221  // Documented in base class.
222  virtual void
224  common::xml::dom::Element& element) const;
225 
226  public:
227  // Documented in superclass.
228  const std::string&
229  getXMLNamespace() const;
230  };
231 
232  }
233  }
234 }
235 
236 #endif // OME_XML_MODEL_MANUFACTURERSPEC_H
237 
238 /*
239  * Local Variables:
240  * mode:C++
241  * End:
242  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:61
void setModel(std::shared_ptr< std::string > &model)
Set the Model property.
Definition: ManufacturerSpec.cpp:264
std::shared_ptr< std::string > getManufacturer()
Get the Manufacturer property.
Definition: ManufacturerSpec.cpp:292
virtual void 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:312
virtual SKIP 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:164
void setLotNumber(std::shared_ptr< std::string > &lotNumber)
Set the LotNumber property.
Definition: ManufacturerSpec.cpp:243
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: ManufacturerSpec.cpp:369
ManufacturerSpec()
Default constructor.
Definition: ManufacturerSpec.cpp:134
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
Private implementation details of ManufacturerSpec model object.
Definition: ManufacturerSpec.cpp:70
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: ManufacturerSpec.cpp:158
Open Microscopy Environment C++ implementation.
virtual ~ManufacturerSpec()
Destructor.
Definition: ManufacturerSpec.cpp:153
std::shared_ptr< Impl > impl
Private implementation details.
Definition: ManufacturerSpec.h:81
void setSerialNumber(std::shared_ptr< std::string > &serialNumber)
Set the SerialNumber property.
Definition: ManufacturerSpec.cpp:285
std::shared_ptr< std::string > getModel()
Get the Model property.
Definition: ManufacturerSpec.cpp:250
void setManufacturer(std::shared_ptr< std::string > &manufacturer)
Set the Manufacturer property.
Definition: ManufacturerSpec.cpp:306
std::shared_ptr< std::string > getSerialNumber()
Get the SerialNumber property.
Definition: ManufacturerSpec.cpp:271
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:78
std::shared_ptr< std::string > getLotNumber()
Get the LotNumber property.
Definition: ManufacturerSpec.cpp:229
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: ManufacturerSpec.cpp:214