ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

Filament.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_FILAMENT_H
47 #define OME_XML_MODEL_FILAMENT_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/LightSource.h>
63 #include <ome/xml/model/enums/FilamentType.h>
64
65 namespace ome
66 {
67 namespace xml
68 {
69 namespace model
70 {
71
72 // Forward declarations.
73 class OMEModel;
74
78 class Filament : public LightSource
79 {
80 private:
81 class Impl;
83 ome::compat::shared_ptr<Impl> impl;
84
85 public:
87 Filament();
88
94 Filament (const Filament& copy);
95
97 virtual
98 ~Filament ();
99
114 static ome::compat::shared_ptr< Filament>
115 create(const common::xml::dom::Element& element,
116 ome::xml::model::OMEModel& model);
117
118 // Documented in superclass.
119 const std::string&
120 elementName() const;
121
122 // Documented in superclass.
123 bool
124 validElementName(const std::string& name) const;
125
126
127 // -- OMEModelObject API methods --
128
130 virtual void
131 update(const common::xml::dom::Element& element,
132 ome::xml::model::OMEModel& model);
133
134 public:
135 // -- Filament API methods --
136
138 bool
139 link (ome::compat::shared_ptr<Reference>& reference,
140 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
141
147 ome::compat::shared_ptr<ome::xml::model::enums::FilamentType>
148 getType ();
149
155 const ome::compat::shared_ptr<ome::xml::model::enums::FilamentType>
156 getType () const;
157
163 void
164 setType (ome::compat::shared_ptr<ome::xml::model::enums::FilamentType>& type);
165
166 const std::string&
167 getLightSourceType() const;
168
170 virtual common::xml::dom::Element
171 asXMLElement (common::xml::dom::Document& document) const;
172
173
174 protected:
175 // Documented in base class.
176 virtual common::xml::dom::Element
177 asXMLElementInternal (common::xml::dom::Document& document,
178 common::xml::dom::Element& element) const;
179
180 public:
181 // Documented in superclass.
182 const std::string&
183 getXMLNamespace() const;
184 };
185
186 }
187 }
188 }
189
190 #endif // OME_XML_MODEL_FILAMENT_H
191
192 /*
193 * Local Variables:
194 * mode:C++
195 * End:
196 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Filament::~Filament
virtual ~Filament()
Destructor.
Definition: Filament.cpp:130
ome::xml::model::Filament::Impl
Private implementation details of Filament model object.
Definition: Filament.cpp:71
ome::xml::model::Filament::create
static ome::compat::shared_ptr< Filament > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Filament model object from DOM element.
Definition: Filament.cpp:135
ome::xml::model::Filament::setType
void setType(ome::compat::shared_ptr< ome::xml::model::enums::FilamentType > &type)
Set the Type property.
Definition: Filament.cpp:209
ome::xml::model::Filament::Filament
Filament()
Default constructor.
Definition: Filament.cpp:111
ome::xml::model::Filament::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Filament.cpp:144
ome::xml::model::Filament::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Filament.cpp:222
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Filament::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: Filament.cpp:160
ome::xml::model::Filament::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: Filament.cpp:229
ome::xml::model::Filament::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Filament.cpp:256
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Filament::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Filament.cpp:151
ome::xml::model::Filament::getLightSourceType
const std::string & getLightSourceType() const
Get the LightSource type.
Definition: Filament.cpp:215
ome::xml::model::Filament::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: Filament.cpp:180
ome::xml::model::Filament
Filament model object.
Definition: Filament.h:78
ome::xml::model::LightSource
LightSource model object.
Definition: LightSource.h:78
ome::xml::model::Filament::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Filament.h:81
ome::xml::model::Filament::getType
ome::compat::shared_ptr< ome::xml::model::enums::FilamentType > getType()
Get the Type property.
Definition: Filament.cpp:195
log.h