ome-xml 5.2.0

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

- File List

FilterSet.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_FILTERSET_H
47 #define OME_XML_MODEL_FILTERSET_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/Instrument.h>
64 #include <ome/xml/model/ManufacturerSpec.h>
65
66 namespace ome
67 {
68 namespace xml
69 {
70 namespace model
71 {
72
73 // Forward declarations.
74 class Channel;
75 class Filter;
76 class OMEModel;
77
81 class FilterSet : public ManufacturerSpec
82 {
83 private:
84 class Impl;
86 ome::compat::shared_ptr<Impl> impl;
87
88 public:
90 FilterSet();
91
97 FilterSet (const FilterSet& copy);
98
100 virtual
101 ~FilterSet ();
102
117 static ome::compat::shared_ptr< FilterSet>
118 create(const common::xml::dom::Element& element,
119 ome::xml::model::OMEModel& model);
120
121 // Documented in superclass.
122 const std::string&
123 elementName() const;
124
125 // Documented in superclass.
126 bool
127 validElementName(const std::string& name) const;
128
129
130 // -- OMEModelObject API methods --
131
133 virtual void
134 update(const common::xml::dom::Element& element,
135 ome::xml::model::OMEModel& model);
136
137 public:
138 // -- FilterSet API methods --
139
141 bool
142 link (ome::compat::shared_ptr<Reference>& reference,
143 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
144
150 const std::string&
151 getID () const;
152
158 void
159 setID (const std::string& id);
160
166 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
167 sizeOfLinkedExcitationFilterList () const;
168
174 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
175 getLinkedExcitationFilterList () const;
176
184 const ome::compat::weak_ptr<ome::xml::model::Filter>&
185 getLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
186
197 const ome::compat::weak_ptr<ome::xml::model::Filter>&
198 setLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
199 const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
200
211 bool
212 linkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
213
229 bool
230 unlinkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
231
238 ome::compat::weak_ptr<ome::xml::model::Dichroic>
239 getLinkedDichroic ();
240
247 const ome::compat::weak_ptr<ome::xml::model::Dichroic>
248 getLinkedDichroic () const;
249
255 void
256 linkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
257
267 void
268 unlinkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
269
275 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
276 sizeOfLinkedEmissionFilterList () const;
277
283 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
284 getLinkedEmissionFilterList () const;
285
293 const ome::compat::weak_ptr<ome::xml::model::Filter>&
294 getLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
295
306 const ome::compat::weak_ptr<ome::xml::model::Filter>&
307 setLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
308 const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
309
320 bool
321 linkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
322
338 bool
339 unlinkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
340
346 OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type
347 sizeOfLinkedChannelList () const;
348
354 OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type
355 getLinkedChannelList () const;
356
364 const ome::compat::weak_ptr<ome::xml::model::Channel>&
365 getLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type index) const;
366
377 const ome::compat::weak_ptr<ome::xml::model::Channel>&
378 setLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type index,
379 const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
380
391 bool
392 linkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
393
409 bool
410 unlinkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
411
417 ome::compat::weak_ptr<ome::xml::model::Instrument>
418 getInstrument ();
419
425 const ome::compat::weak_ptr<ome::xml::model::Instrument>
426 getInstrument () const;
427
433 void
434 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
435
436
438 virtual common::xml::dom::Element
439 asXMLElement (common::xml::dom::Document& document) const;
440
441
442 protected:
443 // Documented in base class.
444 virtual common::xml::dom::Element
445 asXMLElementInternal (common::xml::dom::Document& document,
446 common::xml::dom::Element& element) const;
447
448 public:
449 // Documented in superclass.
450 const std::string&
451 getXMLNamespace() const;
452 };
453
454 }
455 }
456 }
457
458 #endif // OME_XML_MODEL_FILTERSET_H
459
460 /*
461 * Local Variables:
462 * mode:C++
463 * End:
464 */
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::FilterSet::FilterSet
FilterSet()
Default constructor.
Definition: FilterSet.cpp:153
ome::xml::model::FilterSet::getLinkedEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedEmissionFilterList() const
Get the linked EmissionFilter list.
Definition: FilterSet.cpp:432
ome::xml::model::FilterSet::linkDichroic
void linkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Link Dichroic.
Definition: FilterSet.cpp:410
ome::xml::model::FilterSet::setID
void setID(const std::string &id)
Set the ID property.
Definition: FilterSet.cpp:330
ome::xml::model::FilterSet::getInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: FilterSet.cpp:544
ome::xml::model::FilterSet::setInstrument
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: FilterSet.cpp:558
ome::xml::model::FilterSet::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: FilterSet.cpp:186
ome::xml::model::FilterSet::unlinkDichroic
void unlinkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Unlink Dichroic.
Definition: FilterSet.cpp:416
ome::xml::model::FilterSet::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: FilterSet.cpp:193
ome::common::xml::dom::Document
ome::common::xml::dom::Element
ome::xml::model::FilterSet::unlinkEmissionFilter
bool unlinkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Unlink EmissionFilter.
Definition: FilterSet.cpp:468
ome::xml::model::FilterSet::~FilterSet
virtual ~FilterSet()
Destructor.
Definition: FilterSet.cpp:172
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::FilterSet::getLinkedExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type getLinkedExcitationFilterList() const
Get the linked ExcitationFilter list.
Definition: FilterSet.cpp:343
ome::xml::model::FilterSet::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: FilterSet.cpp:572
ome::xml::model::FilterSet::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: FilterSet.h:84
ome::xml::model::FilterSet::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: FilterSet.cpp:355
ome::xml::model::FilterSet::getLinkedChannelList
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type getLinkedChannelList() const
Get the linked Channel list.
Definition: FilterSet.cpp:492
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::FilterSet::linkChannel
bool linkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Link Channel.
Definition: FilterSet.cpp:514
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::FilterSet::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: FilterSet.cpp:265
ome::xml::model::FilterSet::unlinkExcitationFilter
bool unlinkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Unlink ExcitationFilter.
Definition: FilterSet.cpp:379
ome::xml::model::FilterSet::sizeOfLinkedEmissionFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedEmissionFilterList() const
Get size of linked EmissionFilter list.
Definition: FilterSet.cpp:426
ome::xml::model::FilterSet::create
static ome::compat::shared_ptr< FilterSet > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a FilterSet model object from DOM element.
Definition: FilterSet.cpp:177
ome::xml::model::FilterSet::unlinkChannel
bool unlinkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Unlink Channel.
Definition: FilterSet.cpp:527
ome::xml::model::FilterSet::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: FilterSet.cpp:349
ome::xml::model::FilterSet::getLinkedChannel
const ome::compat::weak_ptr< ome::xml::model::Channel > & getLinkedChannel(OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type index) const
Get linked Channel.
Definition: FilterSet.cpp:498
ome::xml::model::FilterSet::setLinkedChannel
const ome::compat::weak_ptr< ome::xml::model::Channel > & setLinkedChannel(OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Set linked Channel.
Definition: FilterSet.cpp:504
ome::xml::model::ManufacturerSpec
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
ome::xml::model::FilterSet::Impl
Private implementation details of FilterSet model object.
Definition: FilterSet.cpp:78
ome::xml::model::FilterSet::linkExcitationFilter
bool linkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Link ExcitationFilter.
Definition: FilterSet.cpp:365
ome::xml::model::FilterSet::getID
const std::string & getID() const
Get the ID property.
Definition: FilterSet.cpp:323
ome::xml::model::FilterSet::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: FilterSet.cpp:444
ome::xml::model::FilterSet::sizeOfLinkedExcitationFilterList
OMEModelObject::indexed_container< ome::xml::model::Filter, ome::compat::weak_ptr >::type::size_type sizeOfLinkedExcitationFilterList() const
Get size of linked ExcitationFilter list.
Definition: FilterSet.cpp:337
ome::xml::model::FilterSet::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: FilterSet.cpp:438
ome::xml::model::FilterSet
FilterSet model object.
Definition: FilterSet.h:81
ome::xml::model::FilterSet::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: FilterSet.cpp:660
ome::xml::model::FilterSet::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: FilterSet.cpp:202
log.h
ome::xml::model::FilterSet::getLinkedDichroic
ome::compat::weak_ptr< ome::xml::model::Dichroic > getLinkedDichroic()
Get linked Dichroic.
Definition: FilterSet.cpp:397
ome::xml::model::FilterSet::sizeOfLinkedChannelList
OMEModelObject::indexed_container< ome::xml::model::Channel, ome::compat::weak_ptr >::type::size_type sizeOfLinkedChannelList() const
Get size of linked Channel list.
Definition: FilterSet.cpp:486
ome::xml::model::FilterSet::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: FilterSet.cpp:565
ome::xml::model::FilterSet::linkEmissionFilter
bool linkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Link EmissionFilter.
Definition: FilterSet.cpp:454