ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Dichroic.h>
65 #include <ome/xml/model/detail/OMEModelObject.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class Annotation;
76 class Filter;
77 class OMEModel;
78
82 class LightPath : public detail::OMEModelObject
83 {
84 private:
85 class Impl;
87 ome::compat::shared_ptr<Impl> impl;
88
89 public:
91 LightPath();
92
98 LightPath (const LightPath& copy);
99
101 virtual
102 ~LightPath ();
103
118 static ome::compat::shared_ptr< LightPath>
119 create(const common::xml::dom::Element& element,
120 ome::xml::model::OMEModel& model);
121
122 // Documented in superclass.
123 const std::string&
124 elementName() const;
125
126 // Documented in superclass.
127 bool
128 validElementName(const std::string& name) const;
129
130 private:
132 LightPath&
133 operator= (const LightPath&);
134
135 public:
136 // -- OMEModelObject API methods --
137
139 virtual void
140 update(const common::xml::dom::Element& element,
141 ome::xml::model::OMEModel& model);
142
143 public:
144 // -- LightPath API methods --
145
147 bool
148 link (ome::compat::shared_ptr<Reference>& reference,
149 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
150
156 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
157 sizeOfLinkedExcitationFilterList () const;
158
164 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
165 getLinkedExcitationFilterList () const;
166
174 const ome::compat::weak_ptr<ome::xml::model::Filter>&
175 getLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
176
187 const ome::compat::weak_ptr<ome::xml::model::Filter>&
188 setLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
189 const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
190
201 bool
202 linkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
203
219 bool
220 unlinkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
221
228 ome::compat::weak_ptr<ome::xml::model::Dichroic>
229 getLinkedDichroic ();
230
237 const ome::compat::weak_ptr<ome::xml::model::Dichroic>
238 getLinkedDichroic () const;
239
245 void
246 linkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
247
257 void
258 unlinkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
259
265 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
266 sizeOfLinkedEmissionFilterList () const;
267
273 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
274 getLinkedEmissionFilterList () const;
275
283 const ome::compat::weak_ptr<ome::xml::model::Filter>&
284 getLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
285
296 const ome::compat::weak_ptr<ome::xml::model::Filter>&
297 setLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
298 const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
299
310 bool
311 linkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
312
328 bool
329 unlinkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
330
336 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
337 sizeOfLinkedAnnotationList () const;
338
344 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
345 getLinkedAnnotationList () const;
346
354 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
355 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
356
367 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
368 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
369 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
370
381 bool
382 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
383
399 bool
400 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
401
403 virtual common::xml::dom::Element
404 asXMLElement (common::xml::dom::Document& document) const;
405
406
407 protected:
408 // Documented in base class.
409 virtual common::xml::dom::Element
410 asXMLElementInternal (common::xml::dom::Document& document,
411 common::xml::dom::Element& element) const;
412
413 public:
414 // Documented in superclass.
415 const std::string&
416 getXMLNamespace() const;
417 };
418
419 }
420 }
421 }
422
423 #endif // OME_XML_MODEL_LIGHTPATH_H
424
425 /*
426 * Local Variables:
427 * mode:C++
428 * End:
429 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
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:174
ome::xml::model::LightPath::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: LightPath.cpp:509
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:324
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:244
ome::xml::model::LightPath::getLinkedDichroic
ome::compat::weak_ptr< ome::xml::model::Dichroic > getLinkedDichroic()
Get linked Dichroic.
Definition: LightPath.cpp:378
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:336
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:419
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:425
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:397
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:330
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::getLinkedEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedEmissionFilterList() const
Get the linked EmissionFilter list.
Definition: LightPath.cpp:413
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:158
ome::xml::model::LightPath::operator=
LightPath & operator=(const LightPath &)
Assignment operator (deleted).
ome::xml::model::LightPath::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: LightPath.cpp:167
ome::xml::model::LightPath::~LightPath
virtual ~LightPath()
Destructor.
Definition: LightPath.cpp:153
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::LightPath::setLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: LightPath.cpp:485
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::LightPath::linkExcitationFilter
bool linkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Link ExcitationFilter.
Definition: LightPath.cpp:346
ome::xml::model::LightPath::linkDichroic
void linkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Link Dichroic.
Definition: LightPath.cpp:391
ome::xml::model::LightPath::getLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: LightPath.cpp:479
ome::xml::model::LightPath::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: LightPath.cpp:495
ome::xml::model::LightPath::LightPath
LightPath()
Default constructor.
Definition: LightPath.cpp:138
ome::xml::model::LightPath::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: LightPath.cpp:630
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:182
ome::xml::model::LightPath
LightPath model object.
Definition: LightPath.h:82
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:533
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:526
ome::xml::model::LightPath::Impl
Private implementation details of LightPath model object.
Definition: LightPath.cpp:78
ome::xml::model::LightPath::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: LightPath.cpp:473
ome::xml::model::LightPath::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: LightPath.h:85
log.h
ome::xml::model::LightPath::linkEmissionFilter
bool linkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Link EmissionFilter.
Definition: LightPath.cpp:435
ome::xml::model::LightPath::unlinkEmissionFilter
bool unlinkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Unlink EmissionFilter.
Definition: LightPath.cpp:449
ome::xml::model::LightPath::unlinkExcitationFilter
bool unlinkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Unlink ExcitationFilter.
Definition: LightPath.cpp:360
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:318
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:407
ome::xml::model::LightPath::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: LightPath.cpp:467