ome-xml 5.2.0

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

- File List

LightPath.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_LIGHTPATH_H
47 #define OME_XML_MODEL_LIGHTPATH_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/Dichroic.h>
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 Filter;
74 class OMEModel;
75
79 class LightPath : public detail::OMEModelObject
80 {
81 private:
82 class Impl;
84 ome::compat::shared_ptr<Impl> impl;
85
86 public:
88 LightPath();
89
95 LightPath (const LightPath& copy);
96
98 virtual
99 ~LightPath ();
100
115 static ome::compat::shared_ptr< LightPath>
116 create(const common::xml::dom::Element& element,
117 ome::xml::model::OMEModel& model);
118
119 // Documented in superclass.
120 const std::string&
121 elementName() const;
122
123 // Documented in superclass.
124 bool
125 validElementName(const std::string& name) const;
126
127
128 // -- OMEModelObject API methods --
129
131 virtual void
132 update(const common::xml::dom::Element& element,
133 ome::xml::model::OMEModel& model);
134
135 public:
136 // -- LightPath API methods --
137
139 bool
140 link (ome::compat::shared_ptr<Reference>& reference,
141 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
142
148 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
149 sizeOfLinkedExcitationFilterList () const;
150
156 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
157 getLinkedExcitationFilterList () const;
158
166 const ome::compat::weak_ptr<ome::xml::model::Filter>&
167 getLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
168
179 const ome::compat::weak_ptr<ome::xml::model::Filter>&
180 setLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
181 const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
182
193 bool
194 linkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
195
211 bool
212 unlinkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
213
220 ome::compat::weak_ptr<ome::xml::model::Dichroic>
221 getLinkedDichroic ();
222
229 const ome::compat::weak_ptr<ome::xml::model::Dichroic>
230 getLinkedDichroic () const;
231
237 void
238 linkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
239
249 void
250 unlinkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
251
257 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
258 sizeOfLinkedEmissionFilterList () const;
259
265 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
266 getLinkedEmissionFilterList () const;
267
275 const ome::compat::weak_ptr<ome::xml::model::Filter>&
276 getLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
277
288 const ome::compat::weak_ptr<ome::xml::model::Filter>&
289 setLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
290 const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
291
302 bool
303 linkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
304
320 bool
321 unlinkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
322
323
325 virtual common::xml::dom::Element
326 asXMLElement (common::xml::dom::Document& document) const;
327
328
329 protected:
330 // Documented in base class.
331 virtual common::xml::dom::Element
332 asXMLElementInternal (common::xml::dom::Document& document,
333 common::xml::dom::Element& element) const;
334
335 public:
336 // Documented in superclass.
337 const std::string&
338 getXMLNamespace() const;
339 };
340
341 }
342 }
343 }
344
345 #endif // OME_XML_MODEL_LIGHTPATH_H
346
347 /*
348 * Local Variables:
349 * mode:C++
350 * End:
351 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::LightPath::sizeOfLinkedExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExcitationFilterList() const
Get size of linked ExcitationFilter list.
Definition: LightPath.cpp:286
ome::xml::model::LightPath::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: LightPath.cpp:228
ome::xml::model::LightPath::getLinkedEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedEmissionFilterList() const
Get the linked EmissionFilter list.
Definition: LightPath.cpp:381
ome::xml::model::LightPath::getLinkedExcitationFilter
const ome::compat::weak_ptr< ome::xml::model::Filter > & getLinkedExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index) const
Get linked ExcitationFilter.
Definition: LightPath.cpp:298
ome::xml::model::LightPath::getLinkedDichroic
ome::compat::weak_ptr< ome::xml::model::Dichroic > getLinkedDichroic()
Get linked Dichroic.
Definition: LightPath.cpp:346
ome::xml::model::LightPath::setLinkedExcitationFilter
const ome::compat::weak_ptr< ome::xml::model::Filter > & setLinkedExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Set linked ExcitationFilter.
Definition: LightPath.cpp:304
ome::xml::model::LightPath::setLinkedEmissionFilter
const ome::compat::weak_ptr< ome::xml::model::Filter > & setLinkedEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Set linked EmissionFilter.
Definition: LightPath.cpp:393
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::LightPath::unlinkDichroic
void unlinkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Unlink Dichroic.
Definition: LightPath.cpp:365
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::LightPath::create
static ome::compat::shared_ptr< LightPath > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a LightPath model object from DOM element.
Definition: LightPath.cpp:154
ome::xml::model::LightPath::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: LightPath.cpp:442
ome::xml::model::LightPath::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: LightPath.cpp:170
ome::xml::model::LightPath::sizeOfLinkedEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedEmissionFilterList() const
Get size of linked EmissionFilter list.
Definition: LightPath.cpp:375
ome::xml::model::LightPath::~LightPath
virtual ~LightPath()
Destructor.
Definition: LightPath.cpp:149
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::LightPath::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: LightPath.cpp:435
ome::xml::model::LightPath::linkExcitationFilter
bool linkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Link ExcitationFilter.
Definition: LightPath.cpp:314
ome::xml::model::LightPath::linkDichroic
void linkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Link Dichroic.
Definition: LightPath.cpp:359
ome::xml::model::LightPath::LightPath
LightPath()
Default constructor.
Definition: LightPath.cpp:130
ome::xml::model::LightPath::getLinkedEmissionFilter
const ome::compat::weak_ptr< ome::xml::model::Filter > & getLinkedEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type index) const
Get linked EmissionFilter.
Definition: LightPath.cpp:387
ome::xml::model::LightPath::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: LightPath.cpp:179
ome::xml::model::LightPath
LightPath model object.
Definition: LightPath.h:79
ome::xml::model::LightPath::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightPath.cpp:517
ome::xml::model::LightPath::Impl
Private implementation details of LightPath model object.
Definition: LightPath.cpp:76
log.h
ome::xml::model::LightPath::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: LightPath.h:82
ome::xml::model::LightPath::getLinkedExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedExcitationFilterList() const
Get the linked ExcitationFilter list.
Definition: LightPath.cpp:292
ome::xml::model::LightPath::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: LightPath.cpp:163
ome::xml::model::LightPath::linkEmissionFilter
bool linkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Link EmissionFilter.
Definition: LightPath.cpp:403
ome::xml::model::LightPath::unlinkEmissionFilter
bool unlinkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Unlink EmissionFilter.
Definition: LightPath.cpp:417
ome::xml::model::LightPath::unlinkExcitationFilter
bool unlinkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Unlink ExcitationFilter.
Definition: LightPath.cpp:328