bioformats  5.1.2
Pump.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_PUMP_H
47 #define OME_XML_MODEL_PUMP_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/Reference.h>
63 
64 namespace ome
65 {
66  namespace xml
67  {
68  namespace model
69  {
70 
71  // Forward declarations.
72  class Laser;
73  class OMEModel;
74 
78  class Pump : public Reference
79  {
80  private:
82  std::string id;
85 
86  public:
88  Pump ();
89 
95  Pump (const Pump& copy);
96 
98  virtual
99  ~Pump ();
100 
101 
102 
117  static ome::compat::shared_ptr< Pump>
118  create(const common::xml::dom::Element& element,
120 
121  // Documented in superclass.
122  const std::string&
123  elementName() const;
124 
125  // Documented in superclass.
126  bool
127  validElementName(const std::string& name) const;
128 
129 
130  // -- OMEModelObject API methods --
131 
133  virtual void
134  update(const common::xml::dom::Element& element,
136 
137  public:
138  // -- Pump API methods --
139 
141  bool
142  link (ome::compat::shared_ptr<Reference>& reference,
143  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144 
150  const std::string&
151  getID () const;
152 
158  void
159  setID (const std::string& id);
160 
167  sizeOfLinkedLaserList () const;
168 
175  getLinkedLaserList () const;
176 
184  const ome::compat::weak_ptr<ome::xml::model::Laser>&
186 
197  const ome::compat::weak_ptr<ome::xml::model::Laser>&
199  const ome::compat::shared_ptr<ome::xml::model::Laser>& laser_BackReference);
200 
211  bool
212  linkLaser (const ome::compat::shared_ptr<ome::xml::model::Laser>& laser_BackReference);
213 
229  bool
230  unlinkLaser (const ome::compat::shared_ptr<ome::xml::model::Laser>& laser_BackReference);
231 
232 
235  asXMLElement (common::xml::dom::Document& document) const;
236 
237 
238  protected:
239  // Documented in base class.
242  common::xml::dom::Element& element) const;
243 
244  public:
245  // Documented in superclass.
246  const std::string&
247  getXMLNamespace() const;
248  };
249 
250  }
251  }
252 }
253 
254 #endif // OME_XML_MODEL_PUMP_H
255 
256 /*
257  * Local Variables:
258  * mode:C++
259  * End:
260  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
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: Pump.cpp:271
bool linkLaser(const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
Link Laser.
Definition: Pump.cpp:234
OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type getLinkedLaserList() const
Get the linked Laser list.
Definition: Pump.cpp:212
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: Pump.cpp:150
DOM Document wrapper.
Definition: Document.h:82
DOM Element wrapper.
Definition: Element.h:66
void setID(const std::string &id)
Set the ID property.
Definition: Pump.cpp:199
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Pump.cpp:297
OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type sizeOfLinkedLaserList() const
Get size of linked Laser list.
Definition: Pump.cpp:206
std::string id
ID property.
Definition: Pump.h:82
const std::string & elementName() const
Get the element name of this model object.
Definition: Pump.cpp:134
const ome::compat::weak_ptr< ome::xml::model::Laser > & getLinkedLaser(OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type index) const
Get linked Laser.
Definition: Pump.cpp:218
Pump model object.
Definition: Pump.h:78
OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type lasers
Laser_BackReference back reference (occurs more than once)
Definition: Pump.h:84
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
const ome::compat::weak_ptr< ome::xml::model::Laser > & setLinkedLaser(OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
Set linked Laser.
Definition: Pump.cpp:224
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
Pump()
Default constructor.
Definition: Pump.cpp:99
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Pump.cpp:264
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Pump.cpp:141
bool unlinkLaser(const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
Unlink Laser.
Definition: Pump.cpp:247
static ome::compat::shared_ptr< Pump > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Pump model object from DOM element.
Definition: Pump.cpp:125
const std::string & getID() const
Get the ID property.
Definition: Pump.cpp:192
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: Pump.cpp:177
Reference model object.
Definition: Reference.h:77
virtual ~Pump()
Destructor.
Definition: Pump.cpp:120
Boost.Log compatibility.
Xerces-C modern C++ wrapper.
Definition: Base.h:53