ome-xml 5.2.3

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/primitives/Quantity.h>
63
64 #include <ome/xml/model/Dichroic.h>
65 #include <ome/xml/model/Instrument.h>
66 #include <ome/xml/model/ManufacturerSpec.h>
67
68 namespace ome
69 {
70 namespace xml
71 {
72 namespace model
73 {
74
75 // Forward declarations.
76 class Channel;
77 class Filter;
78 class OMEModel;
79
83 class FilterSet : public ManufacturerSpec
84 {
85 private:
86 class Impl;
88 ome::compat::shared_ptr<Impl> impl;
89
90 public:
92 FilterSet();
93
99 FilterSet (const FilterSet& copy);
100
102 virtual
103 ~FilterSet ();
104
119 static ome::compat::shared_ptr< FilterSet>
120 create(const common::xml::dom::Element& element,
121 ome::xml::model::OMEModel& model);
122
123 // Documented in superclass.
124 const std::string&
125 elementName() const;
126
127 // Documented in superclass.
128 bool
129 validElementName(const std::string& name) const;
130
131 private:
133 FilterSet&
134 operator= (const FilterSet&);
135
136 public:
137 // -- OMEModelObject API methods --
138
140 virtual void
141 update(const common::xml::dom::Element& element,
142 ome::xml::model::OMEModel& model);
143
144 public:
145 // -- FilterSet API methods --
146
148 bool
149 link (ome::compat::shared_ptr<Reference>& reference,
150 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
151
157 const std::string&
158 getID () const;
159
165 void
166 setID (const std::string& id);
167
173 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
174 sizeOfLinkedExcitationFilterList () const;
175
181 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
182 getLinkedExcitationFilterList () const;
183
191 const ome::compat::weak_ptr<ome::xml::model::Filter>&
192 getLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
193
204 const ome::compat::weak_ptr<ome::xml::model::Filter>&
205 setLinkedExcitationFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
206 const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
207
218 bool
219 linkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
220
236 bool
237 unlinkExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& excitationFilter);
238
245 ome::compat::weak_ptr<ome::xml::model::Dichroic>
246 getLinkedDichroic ();
247
254 const ome::compat::weak_ptr<ome::xml::model::Dichroic>
255 getLinkedDichroic () const;
256
262 void
263 linkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
264
274 void
275 unlinkDichroic (ome::compat::shared_ptr<ome::xml::model::Dichroic>& dichroic);
276
282 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type
283 sizeOfLinkedEmissionFilterList () const;
284
290 OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type
291 getLinkedEmissionFilterList () const;
292
300 const ome::compat::weak_ptr<ome::xml::model::Filter>&
301 getLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index) const;
302
313 const ome::compat::weak_ptr<ome::xml::model::Filter>&
314 setLinkedEmissionFilter (OMEModelObject::indexed_container<ome::xml::model::Filter, ome::compat::weak_ptr>::type::size_type index,
315 const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
316
327 bool
328 linkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
329
345 bool
346 unlinkEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::Filter>& emissionFilter);
347
353 OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type
354 sizeOfLinkedChannelList () const;
355
361 OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type
362 getLinkedChannelList () const;
363
371 const ome::compat::weak_ptr<ome::xml::model::Channel>&
372 getLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type index) const;
373
384 const ome::compat::weak_ptr<ome::xml::model::Channel>&
385 setLinkedChannel (OMEModelObject::indexed_container<ome::xml::model::Channel, ome::compat::weak_ptr>::type::size_type index,
386 const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
387
398 bool
399 linkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
400
416 bool
417 unlinkChannel (const ome::compat::shared_ptr<ome::xml::model::Channel>& channel_BackReference);
418
424 ome::compat::weak_ptr<ome::xml::model::Instrument>
425 getInstrument ();
426
432 const ome::compat::weak_ptr<ome::xml::model::Instrument>
433 getInstrument () const;
434
440 void
441 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
442
444 virtual common::xml::dom::Element
445 asXMLElement (common::xml::dom::Document& document) const;
446
447
448 protected:
449 // Documented in base class.
450 virtual common::xml::dom::Element
451 asXMLElementInternal (common::xml::dom::Document& document,
452 common::xml::dom::Element& element) const;
453
454 public:
455 // Documented in superclass.
456 const std::string&
457 getXMLNamespace() const;
458 };
459
460 }
461 }
462 }
463
464 #endif // OME_XML_MODEL_FILTERSET_H
465
466 /*
467 * Local Variables:
468 * mode:C++
469 * End:
470 */
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:152
ome::xml::model::FilterSet::linkDichroic
void linkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Link Dichroic.
Definition: FilterSet.cpp:405
ome::xml::model::FilterSet::setID
void setID(const std::string &id)
Set the ID property.
Definition: FilterSet.cpp:325
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:188
ome::xml::model::FilterSet::getInstrument
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: FilterSet.cpp:539
ome::xml::model::FilterSet::getID
const std::string & getID() const
Get the ID property.
Definition: FilterSet.cpp:318
ome::xml::model::FilterSet::setInstrument
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: FilterSet.cpp:553
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:433
ome::xml::model::FilterSet::unlinkDichroic
void unlinkDichroic(ome::compat::shared_ptr< ome::xml::model::Dichroic > &dichroic)
Unlink Dichroic.
Definition: FilterSet.cpp:411
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:559
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:463
ome::xml::model::FilterSet::~FilterSet
virtual ~FilterSet()
Destructor.
Definition: FilterSet.cpp:167
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::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: FilterSet.h:86
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:350
ome::xml::model::FilterSet::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: FilterSet.cpp:181
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:509
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:260
ome::xml::model::FilterSet::unlinkExcitationFilter
bool unlinkExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &excitationFilter)
Unlink ExcitationFilter.
Definition: FilterSet.cpp:374
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:427
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:172
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:493
ome::xml::model::FilterSet::unlinkChannel
bool unlinkChannel(const ome::compat::shared_ptr< ome::xml::model::Channel > &channel_BackReference)
Unlink Channel.
Definition: FilterSet.cpp:522
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:421
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:487
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:332
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:499
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:566
ome::xml::model::ManufacturerSpec
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:79
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:360
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:344
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:439
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:338
ome::xml::model::FilterSet
FilterSet model object.
Definition: FilterSet.h:83
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:196
ome::xml::model::FilterSet::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: FilterSet.cpp:654
ome::xml::model::FilterSet::getLinkedDichroic
ome::compat::weak_ptr< ome::xml::model::Dichroic > getLinkedDichroic()
Get linked Dichroic.
Definition: FilterSet.cpp:392
log.h
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:481
ome::xml::model::FilterSet::linkEmissionFilter
bool linkEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::Filter > &emissionFilter)
Link EmissionFilter.
Definition: FilterSet.cpp:449
ome::xml::model::FilterSet::operator=
FilterSet & operator=(const FilterSet &)
Assignment operator (deleted).