ome-xml 5.2.0

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

- File List

Filter.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_FILTER_H
47 #define OME_XML_MODEL_FILTER_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/Instrument.h>
63 #include <ome/xml/model/ManufacturerSpec.h>
64 #include <ome/xml/model/TransmittanceRange.h>
65 #include <ome/xml/model/enums/FilterType.h>
66
67 namespace ome
68 {
69 namespace xml
70 {
71 namespace model
72 {
73
74 // Forward declarations.
75 class FilterSet;
76 class LightPath;
77 class OMEModel;
78
82 class Filter : public ManufacturerSpec
83 {
84 private:
85 class Impl;
87 ome::compat::shared_ptr<Impl> impl;
88
89 public:
91 Filter();
92
98 Filter (const Filter& copy);
99
101 virtual
102 ~Filter ();
103
118 static ome::compat::shared_ptr< Filter>
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
131 // -- OMEModelObject API methods --
132
134 virtual void
135 update(const common::xml::dom::Element& element,
136 ome::xml::model::OMEModel& model);
137
138 public:
139 // -- Filter API methods --
140
142 bool
143 link (ome::compat::shared_ptr<Reference>& reference,
144 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
145
151 ome::compat::shared_ptr<std::string>
152 getFilterWheel ();
153
159 const ome::compat::shared_ptr<std::string>
160 getFilterWheel () const;
161
167 void
168 setFilterWheel (ome::compat::shared_ptr<std::string>& filterWheel);
169
175 ome::compat::shared_ptr<ome::xml::model::enums::FilterType>
176 getType ();
177
183 const ome::compat::shared_ptr<ome::xml::model::enums::FilterType>
184 getType () const;
185
191 void
192 setType (ome::compat::shared_ptr<ome::xml::model::enums::FilterType>& type);
193
199 const std::string&
200 getID () const;
201
207 void
208 setID (const std::string& id);
209
215 ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>
216 getTransmittanceRange ();
217
223 const ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>
224 getTransmittanceRange () const;
225
231 void
232 setTransmittanceRange (ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>& transmittanceRange);
233
239 ome::compat::weak_ptr<ome::xml::model::Instrument>
240 getInstrument ();
241
247 const ome::compat::weak_ptr<ome::xml::model::Instrument>
248 getInstrument () const;
249
255 void
256 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
257
263 OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type
264 sizeOfLinkedFilterSetExcitationFilterList () const;
265
271 OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type
272 getLinkedFilterSetExcitationFilterList () const;
273
281 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
282 getLinkedFilterSetExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type index) const;
283
294 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
295 setLinkedFilterSetExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type index,
296 const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
297
308 bool
309 linkFilterSetExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
310
326 bool
327 unlinkFilterSetExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
328
334 OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type
335 sizeOfLinkedFilterSetEmissionFilterList () const;
336
342 OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type
343 getLinkedFilterSetEmissionFilterList () const;
344
352 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
353 getLinkedFilterSetEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type index) const;
354
365 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
366 setLinkedFilterSetEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::FilterSet, ome::compat::weak_ptr>::type::size_type index,
367 const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
368
379 bool
380 linkFilterSetEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
381
397 bool
398 unlinkFilterSetEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
399
405 OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type
406 sizeOfLinkedLightPathExcitationFilterList () const;
407
413 OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type
414 getLinkedLightPathExcitationFilterList () const;
415
423 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
424 getLinkedLightPathExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type index) const;
425
436 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
437 setLinkedLightPathExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type index,
438 const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
439
450 bool
451 linkLightPathExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
452
468 bool
469 unlinkLightPathExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
470
476 OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type
477 sizeOfLinkedLightPathEmissionFilterList () const;
478
484 OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type
485 getLinkedLightPathEmissionFilterList () const;
486
494 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
495 getLinkedLightPathEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type index) const;
496
507 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
508 setLinkedLightPathEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::LightPath, ome::compat::weak_ptr>::type::size_type index,
509 const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
510
521 bool
522 linkLightPathEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
523
539 bool
540 unlinkLightPathEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
541
542
544 virtual common::xml::dom::Element
545 asXMLElement (common::xml::dom::Document& document) const;
546
547
548 protected:
549 // Documented in base class.
550 virtual common::xml::dom::Element
551 asXMLElementInternal (common::xml::dom::Document& document,
552 common::xml::dom::Element& element) const;
553
554 public:
555 // Documented in superclass.
556 const std::string&
557 getXMLNamespace() const;
558 };
559
560 }
561 }
562 }
563
564 #endif // OME_XML_MODEL_FILTER_H
565
566 /*
567 * Local Variables:
568 * mode:C++
569 * End:
570 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Filter::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Filter.h:85
ome::xml::model::Filter::getLinkedFilterSetExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetExcitationFilterList() const
Get the linked FilterSetExcitationFilter list.
Definition: Filter.cpp:398
ome::xml::model::Filter::Filter
Filter()
Default constructor.
Definition: Filter.cpp:171
ome::xml::model::Filter::setLinkedFilterSetExcitationFilter
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & setLinkedFilterSetExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Set linked FilterSetExcitationFilter.
Definition: Filter.cpp:410
ome::xml::model::Filter::getType
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > getType()
Get the Type property.
Definition: Filter.cpp:315
ome::xml::model::Filter::setLinkedLightPathEmissionFilter
const ome::compat::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPathEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Set linked LightPathEmissionFilter.
Definition: Filter.cpp:584
ome::xml::model::Filter::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Filter.cpp:698
ome::xml::model::Filter::setTransmittanceRange
void setTransmittanceRange(ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange)
Set the TransmittanceRange property.
Definition: Filter.cpp:364
ome::xml::model::Filter::~Filter
virtual ~Filter()
Destructor.
Definition: Filter.cpp:190
ome::xml::model::Filter::getFilterWheel
ome::compat::shared_ptr< std::string > getFilterWheel()
Get the FilterWheel property.
Definition: Filter.cpp:294
ome::xml::model::Filter::create
static ome::compat::shared_ptr< Filter > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Filter model object from DOM element.
Definition: Filter.cpp:195
ome::xml::model::Filter::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: Filter.cpp:279
ome::xml::model::Filter::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: Filter.cpp:631
ome::xml::model::Filter::sizeOfLinkedFilterSetEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type sizeOfLinkedFilterSetEmissionFilterList() const
Get size of linked FilterSetEmissionFilter list.
Definition: Filter.cpp:450
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::Filter::unlinkLightPathEmissionFilter
bool unlinkLightPathEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathEmissionFilter.
Definition: Filter.cpp:607
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::Filter::unlinkFilterSetExcitationFilter
bool unlinkFilterSetExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetExcitationFilter.
Definition: Filter.cpp:433
ome::xml::model::Filter::setLinkedLightPathExcitationFilter
const ome::compat::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPathExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Set linked LightPathExcitationFilter.
Definition: Filter.cpp:526
ome::xml::model::Filter::linkFilterSetExcitationFilter
bool linkFilterSetExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetExcitationFilter.
Definition: Filter.cpp:420
ome::xml::model::Filter::unlinkFilterSetEmissionFilter
bool unlinkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetEmissionFilter.
Definition: Filter.cpp:491
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::Filter::linkLightPathExcitationFilter
bool linkLightPathExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathExcitationFilter.
Definition: Filter.cpp:536
ome::xml::model::Filter::getLinkedLightPathEmissionFilter
const ome::compat::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPathEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type index) const
Get linked LightPathEmissionFilter.
Definition: Filter.cpp:578
ome::xml::model::Filter::sizeOfLinkedFilterSetExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type sizeOfLinkedFilterSetExcitationFilterList() const
Get size of linked FilterSetExcitationFilter list.
Definition: Filter.cpp:392
ome::xml::model::Filter::linkFilterSetEmissionFilter
bool linkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetEmissionFilter.
Definition: Filter.cpp:478
ome::xml::model::Filter::Impl
Private implementation details of Filter model object.
Definition: Filter.cpp:75
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Filter::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Filter.cpp:211
ome::xml::model::Filter::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: Filter.cpp:220
ome::xml::model::Filter::sizeOfLinkedLightPathEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type sizeOfLinkedLightPathEmissionFilterList() const
Get size of linked LightPathEmissionFilter list.
Definition: Filter.cpp:566
ome::xml::model::Filter::sizeOfLinkedLightPathExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type sizeOfLinkedLightPathExcitationFilterList() const
Get size of linked LightPathExcitationFilter list.
Definition: Filter.cpp:508
ome::xml::model::Filter::getLinkedFilterSetExcitationFilter
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & getLinkedFilterSetExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type index) const
Get linked FilterSetExcitationFilter.
Definition: Filter.cpp:404
ome::xml::model::Filter::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Filter.cpp:204
ome::xml::model::Filter::unlinkLightPathExcitationFilter
bool unlinkLightPathExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathExcitationFilter.
Definition: Filter.cpp:549
ome::xml::model::Filter::getInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Filter.cpp:371
ome::xml::model::Filter::setInstrument
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Filter.cpp:385
ome::xml::model::Filter::getLinkedLightPathEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathEmissionFilterList() const
Get the linked LightPathEmissionFilter list.
Definition: Filter.cpp:572
ome::xml::model::Filter::setType
void setType(ome::compat::shared_ptr< ome::xml::model::enums::FilterType > &type)
Set the Type property.
Definition: Filter.cpp:329
ome::xml::model::ManufacturerSpec
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
ome::xml::model::Filter
Filter model object.
Definition: Filter.h:82
ome::xml::model::Filter::setLinkedFilterSetEmissionFilter
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & setLinkedFilterSetEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Set linked FilterSetEmissionFilter.
Definition: Filter.cpp:468
ome::xml::model::Filter::getID
const std::string & getID() const
Get the ID property.
Definition: Filter.cpp:336
ome::xml::model::Filter::setFilterWheel
void setFilterWheel(ome::compat::shared_ptr< std::string > &filterWheel)
Set the FilterWheel property.
Definition: Filter.cpp:308
ome::xml::model::Filter::getLinkedLightPathExcitationFilter
const ome::compat::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPathExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type index) const
Get linked LightPathExcitationFilter.
Definition: Filter.cpp:520
ome::xml::model::Filter::getLinkedLightPathExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathExcitationFilterList() const
Get the linked LightPathExcitationFilter list.
Definition: Filter.cpp:514
ome::xml::model::Filter::getLinkedFilterSetEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetEmissionFilterList() const
Get the linked FilterSetEmissionFilter list.
Definition: Filter.cpp:456
log.h
ome::xml::model::Filter::getLinkedFilterSetEmissionFilter
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & getLinkedFilterSetEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type index) const
Get linked FilterSetEmissionFilter.
Definition: Filter.cpp:462
ome::xml::model::Filter::getTransmittanceRange
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > getTransmittanceRange()
Get the TransmittanceRange property.
Definition: Filter.cpp:350
ome::xml::model::Filter::setID
void setID(const std::string &id)
Set the ID property.
Definition: Filter.cpp:343
ome::xml::model::Filter::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Filter.cpp:624
ome::xml::model::Filter::linkLightPathEmissionFilter
bool linkLightPathEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathEmissionFilter.
Definition: Filter.cpp:594