bioformats  5.1.8
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,
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,
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>
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 
265 
273 
281  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
283 
294  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
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 
336 
344 
352  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
354 
365  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
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 
407 
415 
423  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
425 
436  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
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 
478 
486 
494  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
496 
507  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
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 
545  asXMLElement (common::xml::dom::Document& document) const;
546 
547 
548  protected:
549  // Documented in base class.
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 model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Filter.h:85
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetExcitationFilterList() const
Get the linked FilterSetExcitationFilter list.
Definition: Filter.cpp:398
Filter()
Default constructor.
Definition: Filter.cpp:171
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::compat::shared_ptr< ome::xml::model::enums::FilterType > getType()
Get the Type property.
Definition: Filter.cpp:315
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
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Filter.cpp:698
void setTransmittanceRange(ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange)
Set the TransmittanceRange property.
Definition: Filter.cpp:364
virtual ~Filter()
Destructor.
Definition: Filter.cpp:190
ome::compat::shared_ptr< std::string > getFilterWheel()
Get the FilterWheel property.
Definition: Filter.cpp:294
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
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
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
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
DOM Document wrapper.
Definition: Document.h:83
DOM Element wrapper.
Definition: Element.h:66
bool unlinkLightPathEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathEmissionFilter.
Definition: Filter.cpp:607
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
bool unlinkFilterSetExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetExcitationFilter.
Definition: Filter.cpp:433
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
bool linkFilterSetExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetExcitationFilter.
Definition: Filter.cpp:420
bool unlinkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetEmissionFilter.
Definition: Filter.cpp:491
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
bool linkLightPathExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathExcitationFilter.
Definition: Filter.cpp:536
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
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
bool linkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetEmissionFilter.
Definition: Filter.cpp:478
Private implementation details of Filter model object.
Definition: Filter.cpp:75
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
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
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
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
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
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
const std::string & elementName() const
Get the element name of this model object.
Definition: Filter.cpp:204
bool unlinkLightPathExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathExcitationFilter.
Definition: Filter.cpp:549
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Filter.cpp:371
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Filter.cpp:385
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathEmissionFilterList() const
Get the linked LightPathEmissionFilter list.
Definition: Filter.cpp:572
void setType(ome::compat::shared_ptr< ome::xml::model::enums::FilterType > &type)
Set the Type property.
Definition: Filter.cpp:329
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:77
Filter model object.
Definition: Filter.h:82
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
const std::string & getID() const
Get the ID property.
Definition: Filter.cpp:336
void setFilterWheel(ome::compat::shared_ptr< std::string > &filterWheel)
Set the FilterWheel property.
Definition: Filter.cpp:308
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
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathExcitationFilterList() const
Get the linked LightPathExcitationFilter list.
Definition: Filter.cpp:514
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetEmissionFilterList() const
Get the linked FilterSetEmissionFilter list.
Definition: Filter.cpp:456
Boost.Log compatibility.
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::compat::shared_ptr< ome::xml::model::TransmittanceRange > getTransmittanceRange()
Get the TransmittanceRange property.
Definition: Filter.cpp:350
void setID(const std::string &id)
Set the ID property.
Definition: Filter.cpp:343
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
Xerces-C modern C++ wrapper.
Definition: Base.h:53
bool linkLightPathEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathEmissionFilter.
Definition: Filter.cpp:594