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> 61 #include <ome/xml/model/primitives/Quantity.h> 63 #include <ome/xml/model/Instrument.h> 64 #include <ome/xml/model/ManufacturerSpec.h> 65 #include <ome/xml/model/TransmittanceRange.h> 66 #include <ome/xml/model/enums/FilterType.h> 89 std::shared_ptr<Impl>
impl;
120 static std::shared_ptr<Filter>
150 link (std::shared_ptr<Reference>& reference,
151 std::shared_ptr<ome::xml::model::OMEModelObject>&
object);
158 std::shared_ptr<std::string>
166 const std::shared_ptr<std::string>
182 std::shared_ptr<ome::xml::model::enums::FilterType>
190 const std::shared_ptr<ome::xml::model::enums::FilterType>
199 setType (std::shared_ptr<ome::xml::model::enums::FilterType>& type);
215 setID (
const std::string&
id);
222 std::shared_ptr<ome::xml::model::TransmittanceRange>
230 const std::shared_ptr<ome::xml::model::TransmittanceRange>
264 const std::weak_ptr<ome::xml::model::Annotation>&
277 const std::weak_ptr<ome::xml::model::Annotation>&
279 const std::shared_ptr<ome::xml::model::Annotation>& annotation);
292 linkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
310 unlinkAnnotation (
const std::shared_ptr<ome::xml::model::Annotation>& annotation);
317 std::weak_ptr<ome::xml::model::Instrument>
325 const std::weak_ptr<ome::xml::model::Instrument>
334 setInstrument (std::weak_ptr<ome::xml::model::Instrument>& instrument_BackReference);
359 const std::weak_ptr<ome::xml::model::FilterSet>&
372 const std::weak_ptr<ome::xml::model::FilterSet>&
374 const std::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
430 const std::weak_ptr<ome::xml::model::FilterSet>&
443 const std::weak_ptr<ome::xml::model::FilterSet>&
445 const std::shared_ptr<ome::xml::model::FilterSet>& filterSet_BackReference);
501 const std::weak_ptr<ome::xml::model::LightPath>&
514 const std::weak_ptr<ome::xml::model::LightPath>&
516 const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
572 const std::weak_ptr<ome::xml::model::LightPath>&
585 const std::weak_ptr<ome::xml::model::LightPath>&
587 const std::shared_ptr<ome::xml::model::LightPath>& lightPath_BackReference);
636 #endif // OME_XML_MODEL_FILTER_H OME model interface (abstract top-level container)
Definition: OMEModel.h:61
std::weak_ptr< ome::xml::model::Instrument > getInstrument()
Get the Instrument property.
Definition: Filter.cpp:460
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Filter.cpp:216
bool linkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Filter.cpp:428
std::shared_ptr< Impl > impl
Private implementation details.
Definition: Filter.h:87
static std::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:200
std::shared_ptr< ome::xml::model::enums::FilterType > getType()
Get the Type property.
Definition: Filter.cpp:344
const std::weak_ptr< ome::xml::model::FilterSet > & setLinkedFilterSetExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Set linked FilterSetExcitationFilter.
Definition: Filter.cpp:499
Filter()
Default constructor.
Definition: Filter.cpp:180
bool unlinkAnnotation(const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Filter.cpp:442
const std::string & elementName() const
Get the element name of this model object.
Definition: Filter.cpp:209
virtual ~Filter()
Destructor.
Definition: Filter.cpp:195
bool linkLightPathEmissionFilter(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathEmissionFilter.
Definition: Filter.cpp:683
void setTransmittanceRange(std::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange)
Set the TransmittanceRange property.
Definition: Filter.cpp:393
void setFilterWheel(std::shared_ptr< std::string > &filterWheel)
Set the FilterWheel property.
Definition: Filter.cpp:337
Filter & operator=(const Filter &)
Assignment operator (deleted).
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type sizeOfLinkedFilterSetEmissionFilterList() const
Get size of linked FilterSetEmissionFilter list.
Definition: Filter.cpp:539
std::shared_ptr< std::string > getFilterWheel()
Get the FilterWheel property.
Definition: Filter.cpp:323
const std::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPathExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index) const
Get linked LightPathExcitationFilter.
Definition: Filter.cpp:609
const std::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Filter.cpp:412
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 > >, std::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:93
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type getLinkedLightPathEmissionFilterList() const
Get the linked LightPathEmissionFilter list.
Definition: Filter.cpp:661
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type getLinkedLightPathExcitationFilterList() const
Get the linked LightPathExcitationFilter list.
Definition: Filter.cpp:603
bool unlinkLightPathExcitationFilter(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathExcitationFilter.
Definition: Filter.cpp:638
bool linkFilterSetExcitationFilter(const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetExcitationFilter.
Definition: Filter.cpp:509
const std::string & getID() const
Get the ID property.
Definition: Filter.cpp:365
void setInstrument(std::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference)
Set the Instrument property.
Definition: Filter.cpp:474
const std::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Filter.cpp:418
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:84
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type sizeOfLinkedLightPathEmissionFilterList() const
Get size of linked LightPathEmissionFilter list.
Definition: Filter.cpp:655
Private implementation details of Filter model object.
Definition: Filter.cpp:78
Open Microscopy Environment C++ implementation.
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:222
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type sizeOfLinkedLightPathExcitationFilterList() const
Get size of linked LightPathExcitationFilter list.
Definition: Filter.cpp:597
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type getLinkedFilterSetExcitationFilterList() const
Get the linked FilterSetExcitationFilter list.
Definition: Filter.cpp:487
bool linkLightPathExcitationFilter(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Link LightPathExcitationFilter.
Definition: Filter.cpp:625
bool unlinkLightPathEmissionFilter(const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Unlink LightPathEmissionFilter.
Definition: Filter.cpp:696
std::shared_ptr< ome::xml::model::TransmittanceRange > getTransmittanceRange()
Get the TransmittanceRange property.
Definition: Filter.cpp:379
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Filter.cpp:400
const std::weak_ptr< ome::xml::model::FilterSet > & getLinkedFilterSetExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type index) const
Get linked FilterSetExcitationFilter.
Definition: Filter.cpp:493
const std::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPathEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Set linked LightPathEmissionFilter.
Definition: Filter.cpp:673
virtual void 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:712
bool unlinkFilterSetEmissionFilter(const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetEmissionFilter.
Definition: Filter.cpp:580
ManufacturerSpec model object.
Definition: ManufacturerSpec.h:78
const std::weak_ptr< ome::xml::model::LightPath > & getLinkedLightPathEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index) const
Get linked LightPathEmissionFilter.
Definition: Filter.cpp:667
Filter model object.
Definition: Filter.h:84
const std::weak_ptr< ome::xml::model::FilterSet > & getLinkedFilterSetEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type index) const
Get linked FilterSetEmissionFilter.
Definition: Filter.cpp:551
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type getLinkedFilterSetEmissionFilterList() const
Get the linked FilterSetEmissionFilter list.
Definition: Filter.cpp:545
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Filter.cpp:406
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Filter.cpp:783
const std::weak_ptr< ome::xml::model::LightPath > & setLinkedLightPathExcitationFilter(OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference)
Set linked LightPathExcitationFilter.
Definition: Filter.cpp:615
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type sizeOfLinkedFilterSetExcitationFilterList() const
Get size of linked FilterSetExcitationFilter list.
Definition: Filter.cpp:481
bool link(std::shared_ptr< Reference > &reference, std::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Filter.cpp:292
void setID(const std::string &id)
Set the ID property.
Definition: Filter.cpp:372
bool unlinkFilterSetExcitationFilter(const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Unlink FilterSetExcitationFilter.
Definition: Filter.cpp:522
void setType(std::shared_ptr< ome::xml::model::enums::FilterType > &type)
Set the Type property.
Definition: Filter.cpp:358
bool linkFilterSetEmissionFilter(const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Link FilterSetEmissionFilter.
Definition: Filter.cpp:567
const std::weak_ptr< ome::xml::model::FilterSet > & setLinkedFilterSetEmissionFilter(OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type index, const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference)
Set linked FilterSetEmissionFilter.
Definition: Filter.cpp:557