46 #ifndef OME_XML_MODEL_FILTER_H 47 #define OME_XML_MODEL_FILTER_H 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> 62 #include <ome/xml/model/primitives/Quantity.h> 64 #include <ome/xml/model/Instrument.h> 65 #include <ome/xml/model/ManufacturerSpec.h> 66 #include <ome/xml/model/TransmittanceRange.h> 67 #include <ome/xml/model/enums/FilterType.h> 90 ome::compat::shared_ptr<Impl>
impl;
121 static ome::compat::shared_ptr< Filter>
151 link (ome::compat::shared_ptr<Reference>& reference,
152 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>&
object);
159 ome::compat::shared_ptr<std::string>
167 const ome::compat::shared_ptr<std::string>
176 setFilterWheel (ome::compat::shared_ptr<std::string>& filterWheel);
183 ome::compat::shared_ptr<ome::xml::model::enums::FilterType>
191 const ome::compat::shared_ptr<ome::xml::model::enums::FilterType>
200 setType (ome::compat::shared_ptr<ome::xml::model::enums::FilterType>& type);
216 setID (
const std::string&
id);
223 ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>
231 const ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>
240 setTransmittanceRange (ome::compat::shared_ptr<ome::xml::model::TransmittanceRange>& transmittanceRange);
265 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
278 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
280 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
293 linkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
311 unlinkAnnotation (
const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
318 ome::compat::weak_ptr<ome::xml::model::Instrument>
326 const ome::compat::weak_ptr<ome::xml::model::Instrument>
335 setInstrument (ome::compat::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
360 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
373 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
375 const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
431 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
444 const ome::compat::weak_ptr<ome::xml::model::FilterSet>&
446 const ome::compat::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
502 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
515 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
517 const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
573 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
586 const ome::compat::weak_ptr<ome::xml::model::LightPath>&
588 const ome::compat::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
642 #endif // OME_XML_MODEL_FILTER_H OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Filter.h:88
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Filter.cpp:426
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Filter.cpp:450
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetExcitationFilterList() const
Get the linked FilterSetExcitationFilter list.
Definition: Filter.cpp:495
Filter()
Default constructor.
Definition: Filter.cpp:180
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:507
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > getType()
Get the Type property.
Definition: Filter.cpp:352
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:681
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Filter.cpp:816
void setTransmittanceRange(ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange)
Set the TransmittanceRange property.
Definition: Filter.cpp:401
virtual ~Filter()
Destructor.
Definition: Filter.cpp:199
ome::compat::shared_ptr< std::string > getFilterWheel()
Get the FilterWheel property.
Definition: Filter.cpp:331
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:204
Filter & operator=(const Filter &)
Assignment operator (deleted).
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:300
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:727
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:547
bool unlinkLightPathEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathEmissionFilter.
Definition: Filter.cpp:704
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:530
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:623
bool linkFilterSetExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetExcitationFilter.
Definition: Filter.cpp:517
bool unlinkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetEmissionFilter.
Definition: Filter.cpp:588
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Filter.cpp:408
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:633
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:675
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:489
bool linkFilterSetEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetEmissionFilter.
Definition: Filter.cpp:575
Private implementation details of Filter model object.
Definition: Filter.cpp:78
Open Microscopy Environment C++ implementation.
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Filter.cpp:220
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:228
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:663
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:605
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:501
const std::string & elementName() const
Get the element name of this model object.
Definition: Filter.cpp:213
bool unlinkLightPathExcitationFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathExcitationFilter.
Definition: Filter.cpp:646
ome::compat::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Filter.cpp:468
void setInstrument(ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Filter.cpp:482
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathEmissionFilterList() const
Get the linked LightPathEmissionFilter list.
Definition: Filter.cpp:669
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Filter.cpp:414
void setType(ome::compat::shared_ptr< ome::xml::model::enums::FilterType > &type)
Set the Type property.
Definition: Filter.cpp:366
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:79
Filter model object.
Definition: Filter.h:85
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:565
const std::string & getID() const
Get the ID property.
Definition: Filter.cpp:373
void setFilterWheel(ome::compat::shared_ptr< std::string > &filterWheel)
Set the FilterWheel property.
Definition: Filter.cpp:345
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:617
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type getLinkedLightPathExcitationFilterList() const
Get the linked LightPathExcitationFilter list.
Definition: Filter.cpp:611
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Filter.cpp:420
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type getLinkedFilterSetEmissionFilterList() const
Get the linked FilterSetEmissionFilter list.
Definition: Filter.cpp:553
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:559
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > getTransmittanceRange()
Get the TransmittanceRange property.
Definition: Filter.cpp:387
void setID(const std::string &id)
Set the ID property.
Definition: Filter.cpp:380
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Filter.cpp:436
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:720
bool linkLightPathEmissionFilter(const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathEmissionFilter.
Definition: Filter.cpp:691