bioformats  5.1.0
Filter.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2015 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:
86  ome::compat::shared_ptr<std::string> filterWheel;
88  ome::compat::shared_ptr<ome::xml::model::enums::FilterType> type;
90  std::string id;
92  ome::compat::shared_ptr<ome::xml::model::TransmittanceRange> transmittanceRange;
94  ome::compat::weak_ptr<ome::xml::model::Instrument> instrument;
103 
104  public:
106  Filter ();
107 
113  Filter (const Filter& copy);
114 
116  virtual
117  ~Filter ();
118 
119 
120 
135  static ome::compat::shared_ptr< Filter>
136  create(const common::xml::dom::Element& element,
138 
139  // Documented in superclass.
140  const std::string&
141  elementName() const;
142 
143  // Documented in superclass.
144  bool
145  validElementName(const std::string& name) const;
146 
147 
148  // -- OMEModelObject API methods --
149 
151  virtual void
152  update(const common::xml::dom::Element& element,
154 
155  public:
156  // -- Filter API methods --
157 
159  bool
160  link (ome::compat::shared_ptr<Reference>& reference,
161  ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
162 
168  ome::compat::shared_ptr<std::string>
169  getFilterWheel ();
170 
176  const ome::compat::shared_ptr<std::string>
177  getFilterWheel () const;
178 
184  void
185  setFilterWheel (ome::compat::shared_ptr<std::string>& filterWheel);
186 
192  ome::compat::shared_ptr<ome::xml::model::enums::FilterType>
193  getType ();
194 
200  const ome::compat::shared_ptr<ome::xml::model::enums::FilterType>
201  getType () const;
202 
208  void
209  setType (ome::compat::shared_ptr<ome::xml::model::enums::FilterType>& type);
210 
216  const std::string&
217  getID () const;
218 
224  void
225  setID (const std::string& id);
226 
232  ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>
234 
240  const ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>
241  getTransmittanceRange () const;
242 
248  void
249  setTransmittanceRange (ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>& transmittanceRange);
250 
256  ome::compat::weak_ptr<ome::xml::model::Instrument>
257  getInstrument ();
258 
264  const ome::compat::weak_ptr<ome::xml::model::Instrument>
265  getInstrument () const;
266 
272  void
273  setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
274 
282 
290 
298  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
300 
311  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
313  const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
314 
325  bool
326  linkFilterSetExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
327 
343  bool
344  unlinkFilterSetExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
345 
353 
361 
369  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
371 
382  const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
384  const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
385 
396  bool
397  linkFilterSetEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
398 
414  bool
415  unlinkFilterSetEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
416 
424 
432 
440  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
442 
453  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
455  const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
456 
467  bool
468  linkLightPathExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
469 
485  bool
486  unlinkLightPathExcitationFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
487 
495 
503 
511  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
513 
524  const ome::compat::weak_ptr<ome::xml::model::LightPath>&
526  const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
527 
538  bool
539  linkLightPathEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
540 
556  bool
557  unlinkLightPathEmissionFilter (const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
558 
559 
562  asXMLElement (common::xml::dom::Document& document) const;
563 
564 
565  protected:
566  // Documented in base class.
569  common::xml::dom::Element& element) const;
570 
571  public:
572  // Documented in superclass.
573  const std::string&
574  getXMLNamespace() const;
575  };
576 
577  }
578  }
579 }
580 
581 #endif // OME_XML_MODEL_FILTER_H
582 
583 /*
584  * Local Variables:
585  * mode:C++
586  * End:
587  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > type
Type property.
Definition: Filter.h:88
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetExcitationFilterList() const
Get the linked FilterSetExcitationFilter list.
Definition: Filter.cpp:367
Filter()
Default constructor.
Definition: Filter.cpp:124
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:379
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > getType()
Get the Type property.
Definition: Filter.cpp:284
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:553
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Filter.cpp:667
void setTransmittanceRange(ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange)
Set the TransmittanceRange property.
Definition: Filter.cpp:333
virtual ~Filter()
Destructor.
Definition: Filter.cpp:159
ome::compat::shared_ptr< std::string > getFilterWheel()
Get the FilterWheel property.
Definition: Filter.cpp:263
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:164
ome::compat::shared_ptr< std::string > model
Model property.
Definition: ManufacturerSpec.h:83
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:248
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:600
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:419
DOM Document wrapper.
Definition: Document.h:80
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:576
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:402
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type lightPathEmissionFilterLinks
LightPath_BackReference back reference (occurs more than once)
Definition: Filter.h:102
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:495
bool linkFilterSetExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetExcitationFilter.
Definition: Filter.cpp:389
bool unlinkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetEmissionFilter.
Definition: Filter.cpp:460
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:505
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:547
ome::compat::shared_ptr< std::string > filterWheel
FilterWheel property.
Definition: Filter.h:86
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:361
bool linkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetEmissionFilter.
Definition: Filter.cpp:447
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:180
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type lightPathExcitationFilterLinks
LightPath_BackReference back reference (occurs more than once)
Definition: Filter.h:100
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:189
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > transmittanceRange
TransmittanceRange property.
Definition: Filter.h:92
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:535
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:477
ome::compat::weak_ptr< ome::xml::model::Instrument > instrument
Instrument_BackReference back reference.
Definition: Filter.h:94
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:373
const std::string & elementName() const
Get the element name of this model object.
Definition: Filter.cpp:173
bool unlinkLightPathExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathExcitationFilter.
Definition: Filter.cpp:518
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Filter.cpp:340
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Filter.cpp:354
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathEmissionFilterList() const
Get the linked LightPathEmissionFilter list.
Definition: Filter.cpp:541
void setType(ome::compat::shared_ptr< ome::xml::model::enums::FilterType > &type)
Set the Type property.
Definition: Filter.cpp:298
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:437
const std::string & getID() const
Get the ID property.
Definition: Filter.cpp:305
void setFilterWheel(ome::compat::shared_ptr< std::string > &filterWheel)
Set the FilterWheel property.
Definition: Filter.cpp:277
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type filterSetExcitationFilterLinks
FilterSet_BackReference back reference (occurs more than once)
Definition: Filter.h:96
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:489
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathExcitationFilterList() const
Get the linked LightPathExcitationFilter list.
Definition: Filter.cpp:483
std::string id
ID property.
Definition: Filter.h:90
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetEmissionFilterList() const
Get the linked FilterSetEmissionFilter list.
Definition: Filter.cpp:425
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type filterSetEmissionFilterLinks
FilterSet_BackReference back reference (occurs more than once)
Definition: Filter.h:98
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:431
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > getTransmittanceRange()
Get the TransmittanceRange property.
Definition: Filter.cpp:319
void setID(const std::string &id)
Set the ID property.
Definition: Filter.cpp:312
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:593
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:563