ome-xml
5.6.0
|
#include <ome/xml/model/Filter.h>
Classes | |
class | Impl |
Private implementation details of Filter model object. More... | |
Public Member Functions | |
Filter () | |
Default constructor. | |
Filter (const Filter ©) | |
Copy constructor. More... | |
virtual | ~Filter () |
Destructor. | |
const std::string & | elementName () const |
Get the element name of this model object. More... | |
bool | validElementName (const std::string &name) const |
Check if a given element name is valid for processing by this model object. More... | |
virtual SKIP void | update (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
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. More... | |
std::shared_ptr< std::string > | getFilterWheel () |
Get the FilterWheel property. More... | |
const std::shared_ptr< std::string > | getFilterWheel () const |
Get the FilterWheel property. More... | |
void | setFilterWheel (std::shared_ptr< std::string > &filterWheel) |
Set the FilterWheel property. More... | |
std::shared_ptr< ome::xml::model::enums::FilterType > | getType () |
Get the Type property. More... | |
const std::shared_ptr< ome::xml::model::enums::FilterType > | getType () const |
Get the Type property. More... | |
void | setType (std::shared_ptr< ome::xml::model::enums::FilterType > &type) |
Set the Type property. More... | |
const std::string & | getID () const |
Get the ID property. More... | |
void | setID (const std::string &id) |
Set the ID property. More... | |
std::shared_ptr< ome::xml::model::TransmittanceRange > | getTransmittanceRange () |
Get the TransmittanceRange property. More... | |
const std::shared_ptr< ome::xml::model::TransmittanceRange > | getTransmittanceRange () const |
Get the TransmittanceRange property. More... | |
void | setTransmittanceRange (std::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange) |
Set the TransmittanceRange property. More... | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | sizeOfLinkedAnnotationList () const |
Get size of linked Annotation list. More... | |
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type | getLinkedAnnotationList () const |
Get the linked Annotation list. More... | |
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. More... | |
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. More... | |
bool | linkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation) |
Link Annotation. More... | |
bool | unlinkAnnotation (const std::shared_ptr< ome::xml::model::Annotation > &annotation) |
Unlink Annotation. More... | |
std::weak_ptr< ome::xml::model::Instrument > | getInstrument () |
Get the Instrument property. More... | |
const std::weak_ptr< ome::xml::model::Instrument > | getInstrument () const |
Get the Instrument property. More... | |
void | setInstrument (std::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference) |
Set the Instrument property. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type | sizeOfLinkedFilterSetExcitationFilterList () const |
Get size of linked FilterSetExcitationFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type | getLinkedFilterSetExcitationFilterList () const |
Get the linked FilterSetExcitationFilter list. More... | |
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. More... | |
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. More... | |
bool | linkFilterSetExcitationFilter (const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Link FilterSetExcitationFilter. More... | |
bool | unlinkFilterSetExcitationFilter (const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Unlink FilterSetExcitationFilter. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type | sizeOfLinkedFilterSetEmissionFilterList () const |
Get size of linked FilterSetEmissionFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type | getLinkedFilterSetEmissionFilterList () const |
Get the linked FilterSetEmissionFilter list. More... | |
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. More... | |
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. More... | |
bool | linkFilterSetEmissionFilter (const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Link FilterSetEmissionFilter. More... | |
bool | unlinkFilterSetEmissionFilter (const std::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Unlink FilterSetEmissionFilter. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type | sizeOfLinkedLightPathExcitationFilterList () const |
Get size of linked LightPathExcitationFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type | getLinkedLightPathExcitationFilterList () const |
Get the linked LightPathExcitationFilter list. More... | |
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. More... | |
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. More... | |
bool | linkLightPathExcitationFilter (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Link LightPathExcitationFilter. More... | |
bool | unlinkLightPathExcitationFilter (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Unlink LightPathExcitationFilter. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type | sizeOfLinkedLightPathEmissionFilterList () const |
Get size of linked LightPathEmissionFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type | getLinkedLightPathEmissionFilterList () const |
Get the linked LightPathEmissionFilter list. More... | |
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. More... | |
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. More... | |
bool | linkLightPathEmissionFilter (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Link LightPathEmissionFilter. More... | |
bool | unlinkLightPathEmissionFilter (const std::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Unlink LightPathEmissionFilter. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
Public Member Functions inherited from ome::xml::model::ManufacturerSpec | |
ManufacturerSpec () | |
Default constructor. | |
ManufacturerSpec (const ManufacturerSpec ©) | |
Copy constructor. More... | |
virtual | ~ManufacturerSpec () |
Destructor. | |
bool | validElementName (const std::string &name) const |
Check if a given element name is valid for processing by this model object. More... | |
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. More... | |
std::shared_ptr< std::string > | getLotNumber () |
Get the LotNumber property. More... | |
const std::shared_ptr< std::string > | getLotNumber () const |
Get the LotNumber property. More... | |
void | setLotNumber (std::shared_ptr< std::string > &lotNumber) |
Set the LotNumber property. More... | |
std::shared_ptr< std::string > | getModel () |
Get the Model property. More... | |
const std::shared_ptr< std::string > | getModel () const |
Get the Model property. More... | |
void | setModel (std::shared_ptr< std::string > &model) |
Set the Model property. More... | |
std::shared_ptr< std::string > | getSerialNumber () |
Get the SerialNumber property. More... | |
const std::shared_ptr< std::string > | getSerialNumber () const |
Get the SerialNumber property. More... | |
void | setSerialNumber (std::shared_ptr< std::string > &serialNumber) |
Set the SerialNumber property. More... | |
std::shared_ptr< std::string > | getManufacturer () |
Get the Manufacturer property. More... | |
const std::shared_ptr< std::string > | getManufacturer () const |
Get the Manufacturer property. More... | |
void | setManufacturer (std::shared_ptr< std::string > &manufacturer) |
Set the Manufacturer property. More... | |
const std::string & | getXMLNamespace () const |
Get the XML namespace for this model object. More... | |
Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
virtual | ~OMEModelObject () |
Destructor. | |
virtual common::xml::dom::Element | asXMLElement (common::xml::dom::Document &document) const |
Transform the object hierarchy rooted at this element to XML. More... | |
virtual void | asXMLElement (common::xml::dom::Document &document, common::xml::dom::Element &element) const |
Transform the object hierarchy rooted at this element to XML. More... | |
virtual void | update (const common::xml::dom::Element &element, ::ome::xml::model::OMEModel &model) |
Update the object hierarchy recursively from an XML DOM tree. More... | |
virtual 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. More... | |
Public Member Functions inherited from ome::xml::model::OMEModelObject | |
virtual bool | link (std::shared_ptr< Reference > &reference, std::shared_ptr< OMEModelObject > &object)=0 |
Link a given OME model object to this model object. More... | |
Static Public Member Functions | |
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. More... | |
Static Public Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
static std::vector< common::xml::dom::Element > | getChildrenByTagName (const common::xml::dom::Element &parent, const std::string &name) |
Retrieve all the children of an element that have a given tag name. More... | |
static std::string | stripNamespacePrefix (const std::string &value) |
Strip the namespace prefix from a tag name. More... | |
Protected Member Functions | |
virtual void | asXMLElementInternal (common::xml::dom::Document &document, common::xml::dom::Element &element) const |
Transform the object hierarchy rooted at this element to XML. More... | |
Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
OMEModelObject (const std::string &objectType="OMEModelObject") | |
Constructor. More... | |
OMEModelObject (const OMEModelObject ©) | |
Copy constructor. More... | |
template<class C , typename T > | |
bool | contains (const C &container, const std::shared_ptr< T > &element) |
Check if a container contains a particular element. More... | |
Protected Member Functions inherited from ome::xml::model::OMEModelObject | |
OMEModelObject () | |
Constructor. | |
Private Attributes | |
std::shared_ptr< Impl > | impl |
Private implementation details. | |
Additional Inherited Members | |
Protected Attributes inherited from ome::xml::model::detail::OMEModelObject | |
ome::common::Logger | logger |
Message logger. | |
Filter model object.
ome::xml::model::Filter::Filter | ( | const Filter & | copy | ) |
Copy constructor.
copy | the Filter to copy. |
|
protectedvirtual |
Transform the object hierarchy rooted at this element to XML.
This internal implementation of asXMLelement also requires an XML element, which must not be null, or may be instantiated and passed from superclasses.
Concrete model object implementations should override this method.
document | XML document for element creation. |
element | XML element for setting model data. |
Reimplemented from ome::xml::model::ManufacturerSpec.
References ome::common::xml::dom::Node::appendChild(), ome::xml::model::ManufacturerSpec::asXMLElementInternal(), ome::common::xml::dom::Document::createElementNS(), getXMLNamespace(), impl, and ome::common::xml::dom::Element::setAttribute().
|
static |
Create a Filter model object from DOM element.
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Referenced by ome::xml::model::Instrument::update().
|
virtual |
Get the element name of this model object.
This will be the most-derived class name.
Implements ome::xml::model::OMEModelObject.
std::shared_ptr< std::string > ome::xml::model::Filter::getFilterWheel | ( | ) |
const std::shared_ptr< std::string > ome::xml::model::Filter::getFilterWheel | ( | ) | const |
const std::string & ome::xml::model::Filter::getID | ( | ) | const |
std::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Filter::getInstrument | ( | ) |
const std::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Filter::getInstrument | ( | ) | const |
const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Filter::getLinkedAnnotation | ( | OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type | index | ) | const |
Get linked Annotation.
index | the index number of the Annotation. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type ome::xml::model::Filter::getLinkedAnnotationList | ( | ) | const |
const std::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::getLinkedFilterSetEmissionFilter | ( | OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type | index | ) | const |
Get linked FilterSetEmissionFilter.
index | the index number of the FilterSetEmissionFilter. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type ome::xml::model::Filter::getLinkedFilterSetEmissionFilterList | ( | ) | const |
const std::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::getLinkedFilterSetExcitationFilter | ( | OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type | index | ) | const |
Get linked FilterSetExcitationFilter.
index | the index number of the FilterSetExcitationFilter. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type ome::xml::model::Filter::getLinkedFilterSetExcitationFilterList | ( | ) | const |
const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::getLinkedLightPathEmissionFilter | ( | OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type | index | ) | const |
Get linked LightPathEmissionFilter.
index | the index number of the LightPathEmissionFilter. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type ome::xml::model::Filter::getLinkedLightPathEmissionFilterList | ( | ) | const |
const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::getLinkedLightPathExcitationFilter | ( | OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type | index | ) | const |
Get linked LightPathExcitationFilter.
index | the index number of the LightPathExcitationFilter. |
std::out_of_range | if the index is invalid. |
References impl.
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type ome::xml::model::Filter::getLinkedLightPathExcitationFilterList | ( | ) | const |
std::shared_ptr< ome::xml::model::TransmittanceRange > ome::xml::model::Filter::getTransmittanceRange | ( | ) |
const std::shared_ptr< ome::xml::model::TransmittanceRange > ome::xml::model::Filter::getTransmittanceRange | ( | ) | const |
std::shared_ptr< ome::xml::model::enums::FilterType > ome::xml::model::Filter::getType | ( | ) |
const std::shared_ptr< ome::xml::model::enums::FilterType > ome::xml::model::Filter::getType | ( | ) | const |
|
virtual |
Get the XML namespace for this model object.
Implements ome::xml::model::OMEModelObject.
Referenced by asXMLElementInternal().
bool ome::xml::model::Filter::link | ( | std::shared_ptr< Reference > & | reference, |
std::shared_ptr< ome::xml::model::OMEModelObject > & | object | ||
) |
Link a given OME model object to this model object.
reference | type qualifier for the reference. This should be the corresponding reference type for object. If, for example, object is of type Image, reference must be of type ImageRef. |
object | Model object to link to. |
true
if this model object was able to handle the reference, otherwise false
.References impl, ome::xml::model::ManufacturerSpec::link(), ome::xml::model::Annotation::linkFilter(), and ome::xml::model::detail::OMEModelObject::logger.
bool ome::xml::model::Filter::linkAnnotation | ( | const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Link Annotation.
annotation | the Annotation to link. |
true
if the object was added to the internal annotationLinks list, otherwise false
.References impl.
bool ome::xml::model::Filter::linkFilterSetEmissionFilter | ( | const std::shared_ptr< ome::xml::model::FilterSet > & | filterSet_BackReference | ) |
Link FilterSetEmissionFilter.
filterSet_BackReference | the FilterSetEmissionFilter to link. |
true
if the object was added to the internal filterSetEmissionFilterLinks list, otherwise false
.References impl.
Referenced by ome::xml::model::FilterSet::link().
bool ome::xml::model::Filter::linkFilterSetExcitationFilter | ( | const std::shared_ptr< ome::xml::model::FilterSet > & | filterSet_BackReference | ) |
Link FilterSetExcitationFilter.
filterSet_BackReference | the FilterSetExcitationFilter to link. |
true
if the object was added to the internal filterSetExcitationFilterLinks list, otherwise false
.References impl.
Referenced by ome::xml::model::FilterSet::link().
bool ome::xml::model::Filter::linkLightPathEmissionFilter | ( | const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ) |
Link LightPathEmissionFilter.
lightPath_BackReference | the LightPathEmissionFilter to link. |
true
if the object was added to the internal lightPathEmissionFilterLinks list, otherwise false
.References impl.
Referenced by ome::xml::model::LightPath::link().
bool ome::xml::model::Filter::linkLightPathExcitationFilter | ( | const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ) |
Link LightPathExcitationFilter.
lightPath_BackReference | the LightPathExcitationFilter to link. |
true
if the object was added to the internal lightPathExcitationFilterLinks list, otherwise false
.References impl.
Referenced by ome::xml::model::LightPath::link().
void ome::xml::model::Filter::setFilterWheel | ( | std::shared_ptr< std::string > & | filterWheel | ) |
void ome::xml::model::Filter::setID | ( | const std::string & | id | ) |
void ome::xml::model::Filter::setInstrument | ( | std::weak_ptr< ome::xml::model::Instrument > & | instrument_BackReference | ) |
const std::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Filter::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.
index | the index number of the Annotation. |
annotation | the Annotation to set. |
std::out_of_range | if the index is invalid. |
References impl.
const std::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::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.
index | the index number of the FilterSetEmissionFilter. |
filterSet_BackReference | the FilterSetEmissionFilter to set. |
std::out_of_range | if the index is invalid. |
References impl.
const std::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::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.
index | the index number of the FilterSetExcitationFilter. |
filterSet_BackReference | the FilterSetExcitationFilter to set. |
std::out_of_range | if the index is invalid. |
References impl.
const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::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.
index | the index number of the LightPathEmissionFilter. |
lightPath_BackReference | the LightPathEmissionFilter to set. |
std::out_of_range | if the index is invalid. |
References impl.
const std::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::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.
index | the index number of the LightPathExcitationFilter. |
lightPath_BackReference | the LightPathExcitationFilter to set. |
std::out_of_range | if the index is invalid. |
References impl.
void ome::xml::model::Filter::setTransmittanceRange | ( | std::shared_ptr< ome::xml::model::TransmittanceRange > & | transmittanceRange | ) |
Set the TransmittanceRange property.
transmittanceRange | the value to set. |
References impl.
Referenced by update().
void ome::xml::model::Filter::setType | ( | std::shared_ptr< ome::xml::model::enums::FilterType > & | type | ) |
OMEModelObject::indexed_container< ome::xml::model::Annotation, std::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedAnnotationList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedFilterSetEmissionFilterList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, std::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedFilterSetExcitationFilterList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedLightPathEmissionFilterList | ( | ) | const |
OMEModelObject::indexed_container< ome::xml::model::LightPath, std::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedLightPathExcitationFilterList | ( | ) | const |
bool ome::xml::model::Filter::unlinkAnnotation | ( | const std::shared_ptr< ome::xml::model::Annotation > & | annotation | ) |
Unlink Annotation.
annotation | the Annotation to unlink. |
true
if the Annotation was unlinked, otherwise false
if the Annotation was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
bool ome::xml::model::Filter::unlinkFilterSetEmissionFilter | ( | const std::shared_ptr< ome::xml::model::FilterSet > & | filterSet_BackReference | ) |
Unlink FilterSetEmissionFilter.
filterSet_BackReference | the FilterSetEmissionFilter to unlink. |
true
if the FilterSetEmissionFilter was unlinked, otherwise false
if the FilterSetEmissionFilter was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
bool ome::xml::model::Filter::unlinkFilterSetExcitationFilter | ( | const std::shared_ptr< ome::xml::model::FilterSet > & | filterSet_BackReference | ) |
Unlink FilterSetExcitationFilter.
filterSet_BackReference | the FilterSetExcitationFilter to unlink. |
true
if the FilterSetExcitationFilter was unlinked, otherwise false
if the FilterSetExcitationFilter was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
bool ome::xml::model::Filter::unlinkLightPathEmissionFilter | ( | const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ) |
Unlink LightPathEmissionFilter.
lightPath_BackReference | the LightPathEmissionFilter to unlink. |
true
if the LightPathEmissionFilter was unlinked, otherwise false
if the LightPathEmissionFilter was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
bool ome::xml::model::Filter::unlinkLightPathExcitationFilter | ( | const std::shared_ptr< ome::xml::model::LightPath > & | lightPath_BackReference | ) |
Unlink LightPathExcitationFilter.
lightPath_BackReference | the LightPathExcitationFilter to unlink. |
true
if the LightPathExcitationFilter was unlinked, otherwise false
if the LightPathExcitationFilter was not linked and could hence not be unlinked.Does the return value serve any useful purpose? Is this also inherited Java API?
Doesn't the removal break the indexing?
Does the removal deal with multiple instances; we aren't preventing duplicates on insertion.
References impl.
|
virtual |
Update the object hierarchy recursively from an XML DOM tree.
element | root of the XML DOM tree to from which to construct the model object graph. |
model | handler for the OME model used to track instances and references seen during the update. |
EnumerationException | if there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing. |
Reimplemented from ome::xml::model::ManufacturerSpec.
References ome::xml::model::OMEModel::addModelObject(), ome::xml::model::OMEModel::addReference(), ome::xml::model::TransmittanceRange::create(), ome::common::xml::dom::Element::getAttribute(), ome::xml::model::detail::OMEModelObject::getChildrenByTagName(), getID(), ome::common::xml::dom::Element::getTagName(), ome::common::xml::dom::Element::hasAttribute(), ome::xml::model::detail::OMEModelObject::logger, setFilterWheel(), setID(), setTransmittanceRange(), setType(), ome::xml::model::ManufacturerSpec::update(), and validElementName().
|
virtual |
Check if a given element name is valid for processing by this model object.
Used for processing nodes when interitance is involved.
name | the element name to check. |
true
if valid, false
if invalid. Implements ome::xml::model::detail::OMEModelObject.
Referenced by update().