ome-xml 5.2.3

Pump.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_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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Reference.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class Laser;
75 class OMEModel;
76
80 class Pump : public Reference
81 {
82 private:
83 class Impl;
85 ome::compat::shared_ptr<Impl> impl;
86
87 public:
89 Pump();
90
96 Pump (const Pump& copy);
97
99 virtual
100 ~Pump ();
101
116 static ome::compat::shared_ptr< Pump>
117 create(const common::xml::dom::Element& element,
118 ome::xml::model::OMEModel& model);
119
120 // Documented in superclass.
121 const std::string&
122 elementName() const;
123
124 // Documented in superclass.
125 bool
126 validElementName(const std::string& name) const;
127
128 private:
130 Pump&
131 operator= (const Pump&);
132
133 public:
134 // -- OMEModelObject API methods --
135
137 virtual void
138 update(const common::xml::dom::Element& element,
139 ome::xml::model::OMEModel& model);
140
141 public:
142 // -- Pump API methods --
143
145 bool
146 link (ome::compat::shared_ptr<Reference>& reference,
147 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
148
154 const std::string&
155 getID () const;
156
162 void
163 setID (const std::string& id);
164
170 OMEModelObject::indexed_container<ome::xml::model::Laser, ome::compat::weak_ptr>::type::size_type
171 sizeOfLinkedLaserList () const;
172
178 OMEModelObject::indexed_container<ome::xml::model::Laser, ome::compat::weak_ptr>::type
179 getLinkedLaserList () const;
180
188 const ome::compat::weak_ptr<ome::xml::model::Laser>&
189 getLinkedLaser (OMEModelObject::indexed_container<ome::xml::model::Laser, ome::compat::weak_ptr>::type::size_type index) const;
190
201 const ome::compat::weak_ptr<ome::xml::model::Laser>&
202 setLinkedLaser (OMEModelObject::indexed_container<ome::xml::model::Laser, ome::compat::weak_ptr>::type::size_type index,
203 const ome::compat::shared_ptr<ome::xml::model::Laser>& laser_BackReference);
204
215 bool
216 linkLaser (const ome::compat::shared_ptr<ome::xml::model::Laser>& laser_BackReference);
217
233 bool
234 unlinkLaser (const ome::compat::shared_ptr<ome::xml::model::Laser>& laser_BackReference);
235
237 virtual common::xml::dom::Element
238 asXMLElement (common::xml::dom::Document& document) const;
239
240
241 protected:
242 // Documented in base class.
243 virtual common::xml::dom::Element
244 asXMLElementInternal (common::xml::dom::Document& document,
245 common::xml::dom::Element& element) const;
246
247 public:
248 // Documented in superclass.
249 const std::string&
250 getXMLNamespace() const;
251 };
252
253 }
254 }
255 }
256
257 #endif // OME_XML_MODEL_PUMP_H
258
259 /*
260 * Local Variables:
261 * mode:C++
262 * End:
263 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Pump::linkLaser
bool linkLaser(const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
Link Laser.
Definition: Pump.cpp:246
ome::xml::model::Pump::getLinkedLaser
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:230
ome::xml::model::Pump::update
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:161
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Pump::asXMLElementInternal
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:282
ome::xml::model::Pump::setID
void setID(const std::string &id)
Set the ID property.
Definition: Pump.cpp:211
ome::xml::model::Pump::Impl
Private implementation details of Pump model object.
Definition: Pump.cpp:71
ome::xml::model::OMEModelObject::indexed_container::type
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
ome::xml::model::Pump::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Pump.cpp:308
ome::xml::model::Pump
Pump model object.
Definition: Pump.h:80
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::xml::model::Pump::setLinkedLaser
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:236
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Pump::getID
const std::string & getID() const
Get the ID property.
Definition: Pump.cpp:204
ome::xml::model::Pump::Pump
Pump()
Default constructor.
Definition: Pump.cpp:117
ome::xml::model::Pump::unlinkLaser
bool unlinkLaser(const ome::compat::shared_ptr< ome::xml::model::Laser > &laser_BackReference)
Unlink Laser.
Definition: Pump.cpp:259
ome::xml::model::Pump::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Pump.h:83
ome::xml::model::Pump::create
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:137
ome::xml::model::Pump::asXMLElement
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:275
ome::xml::model::Pump::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Pump.cpp:146
ome::xml::model::Pump::link
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:189
ome::xml::model::Reference
Reference model object.
Definition: Reference.h:79
ome::xml::model::Pump::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Pump.cpp:153
ome::xml::model::Pump::~Pump
virtual ~Pump()
Destructor.
Definition: Pump.cpp:132
ome::xml::model::Pump::getLinkedLaserList
OMEModelObject::indexed_container< ome::xml::model::Laser, ome::compat::weak_ptr >::type getLinkedLaserList() const
Get the linked Laser list.
Definition: Pump.cpp:224
ome::xml::model::Pump::operator=
Pump & operator=(const Pump &)
Assignment operator (deleted).
log.h
ome::xml::model::Pump::sizeOfLinkedLaserList
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:218