bioformats
5.1.3
|
#include <ome/xml/model/Filter.h>
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 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 (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. More... | |
ome::compat::shared_ptr< std::string > | getFilterWheel () |
Get the FilterWheel property. More... | |
const ome::compat::shared_ptr< std::string > | getFilterWheel () const |
Get the FilterWheel property. More... | |
void | setFilterWheel (ome::compat::shared_ptr< std::string > &filterWheel) |
Set the FilterWheel property. More... | |
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > | getType () |
Get the Type property. More... | |
const ome::compat::shared_ptr< ome::xml::model::enums::FilterType > | getType () const |
Get the Type property. More... | |
void | setType (ome::compat::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... | |
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > | getTransmittanceRange () |
Get the TransmittanceRange property. More... | |
const ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > | getTransmittanceRange () const |
Get the TransmittanceRange property. More... | |
void | setTransmittanceRange (ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > &transmittanceRange) |
Set the TransmittanceRange property. More... | |
ome::compat::weak_ptr< ome::xml::model::Instrument > | getInstrument () |
Get the Instrument property. More... | |
const ome::compat::weak_ptr< ome::xml::model::Instrument > | getInstrument () const |
Get the Instrument property. More... | |
void | setInstrument (ome::compat::weak_ptr< ome::xml::model::Instrument > &instrument_BackReference) |
Set the Instrument property. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedFilterSetExcitationFilterList () const |
Get size of linked FilterSetExcitationFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type | getLinkedFilterSetExcitationFilterList () const |
Get the linked FilterSetExcitationFilter list. More... | |
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. More... | |
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. More... | |
bool | linkFilterSetExcitationFilter (const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Link FilterSetExcitationFilter. More... | |
bool | unlinkFilterSetExcitationFilter (const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Unlink FilterSetExcitationFilter. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedFilterSetEmissionFilterList () const |
Get size of linked FilterSetEmissionFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type | getLinkedFilterSetEmissionFilterList () const |
Get the linked FilterSetEmissionFilter list. More... | |
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. More... | |
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. More... | |
bool | linkFilterSetEmissionFilter (const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Link FilterSetEmissionFilter. More... | |
bool | unlinkFilterSetEmissionFilter (const ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet_BackReference) |
Unlink FilterSetEmissionFilter. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedLightPathExcitationFilterList () const |
Get size of linked LightPathExcitationFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type | getLinkedLightPathExcitationFilterList () const |
Get the linked LightPathExcitationFilter list. More... | |
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. More... | |
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. More... | |
bool | linkLightPathExcitationFilter (const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Link LightPathExcitationFilter. More... | |
bool | unlinkLightPathExcitationFilter (const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Unlink LightPathExcitationFilter. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type | sizeOfLinkedLightPathEmissionFilterList () const |
Get size of linked LightPathEmissionFilter list. More... | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type | getLinkedLightPathEmissionFilterList () const |
Get the linked LightPathEmissionFilter list. More... | |
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. More... | |
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. More... | |
bool | linkLightPathEmissionFilter (const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Link LightPathEmissionFilter. More... | |
bool | unlinkLightPathEmissionFilter (const ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath_BackReference) |
Unlink LightPathEmissionFilter. More... | |
virtual common::xml::dom::Element | asXMLElement (common::xml::dom::Document &document) const |
Transform the object hierarchy rooted at this element to XML. 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 (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. More... | |
ome::compat::shared_ptr< std::string > | getLotNumber () |
Get the LotNumber property. More... | |
const ome::compat::shared_ptr< std::string > | getLotNumber () const |
Get the LotNumber property. More... | |
void | setLotNumber (ome::compat::shared_ptr< std::string > &lotNumber) |
Set the LotNumber property. More... | |
ome::compat::shared_ptr< std::string > | getModel () |
Get the Model property. More... | |
const ome::compat::shared_ptr< std::string > | getModel () const |
Get the Model property. More... | |
void | setModel (ome::compat::shared_ptr< std::string > &model) |
Set the Model property. More... | |
ome::compat::shared_ptr< std::string > | getSerialNumber () |
Get the SerialNumber property. More... | |
const ome::compat::shared_ptr< std::string > | getSerialNumber () const |
Get the SerialNumber property. More... | |
void | setSerialNumber (ome::compat::shared_ptr< std::string > &serialNumber) |
Set the SerialNumber property. More... | |
ome::compat::shared_ptr< std::string > | getManufacturer () |
Get the Manufacturer property. More... | |
const ome::compat::shared_ptr< std::string > | getManufacturer () const |
Get the Manufacturer property. More... | |
void | setManufacturer (ome::compat::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 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 (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. More... | |
Public Member Functions inherited from ome::xml::model::OMEModelObject | |
virtual bool | link (ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< OMEModelObject > &object)=0 |
Link a given OME model object to this model object. More... | |
Static Public Member Functions | |
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. 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 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. More... | |
Protected Member Functions inherited from ome::xml::model::detail::OMEModelObject | |
OMEModelObject (const std::string &objectType="OMEModelObject") | |
Constructor. | |
OMEModelObject (const OMEModelObject ©) | |
Copy constructor. More... | |
template<class C , typename T > | |
bool | contains (const C &container, const ome::compat::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 | |
ome::compat::shared_ptr< std::string > | filterWheel |
FilterWheel property. | |
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > | type |
Type property. | |
std::string | id |
ID property. | |
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > | transmittanceRange |
TransmittanceRange property. | |
ome::compat::weak_ptr< ome::xml::model::Instrument > | instrument |
Instrument_BackReference back reference. | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type | filterSetExcitationFilterLinks |
FilterSet_BackReference back reference (occurs more than once) | |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type | filterSetEmissionFilterLinks |
FilterSet_BackReference back reference (occurs more than once) | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type | lightPathExcitationFilterLinks |
LightPath_BackReference back reference (occurs more than once) | |
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type | lightPathEmissionFilterLinks |
LightPath_BackReference back reference (occurs more than once) | |
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. |
|
virtual |
Transform the object hierarchy rooted at this element to XML.
document | document for element creation |
Reimplemented from ome::xml::model::ManufacturerSpec.
References asXMLElementInternal(), and ome::common::xml::dom::Document::createElementNS().
|
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.
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(), filterWheel, id, ome::common::xml::dom::Element::setAttribute(), transmittanceRange, and type.
Referenced by asXMLElement().
|
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.
References type.
ome::compat::shared_ptr< std::string > ome::xml::model::Filter::getFilterWheel | ( | ) |
const ome::compat::shared_ptr< std::string > ome::xml::model::Filter::getFilterWheel | ( | ) | const |
const std::string & ome::xml::model::Filter::getID | ( | ) | const |
ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Filter::getInstrument | ( | ) |
const ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Filter::getInstrument | ( | ) | const |
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::getLinkedFilterSetEmissionFilter | ( | OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::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 filterSetEmissionFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type ome::xml::model::Filter::getLinkedFilterSetEmissionFilterList | ( | ) | const |
Get the linked FilterSetEmissionFilter list.
References filterSetEmissionFilterLinks.
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::getLinkedFilterSetExcitationFilter | ( | OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::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 filterSetExcitationFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type ome::xml::model::Filter::getLinkedFilterSetExcitationFilterList | ( | ) | const |
Get the linked FilterSetExcitationFilter list.
References filterSetExcitationFilterLinks.
const ome::compat::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::getLinkedLightPathEmissionFilter | ( | OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::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 lightPathEmissionFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type ome::xml::model::Filter::getLinkedLightPathEmissionFilterList | ( | ) | const |
Get the linked LightPathEmissionFilter list.
References lightPathEmissionFilterLinks.
const ome::compat::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::getLinkedLightPathExcitationFilter | ( | OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::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 lightPathExcitationFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type ome::xml::model::Filter::getLinkedLightPathExcitationFilterList | ( | ) | const |
Get the linked LightPathExcitationFilter list.
References lightPathExcitationFilterLinks.
ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > ome::xml::model::Filter::getTransmittanceRange | ( | ) |
Get the TransmittanceRange property.
References transmittanceRange.
const ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > ome::xml::model::Filter::getTransmittanceRange | ( | ) | const |
Get the TransmittanceRange property.
References transmittanceRange.
ome::compat::shared_ptr< ome::xml::model::enums::FilterType > ome::xml::model::Filter::getType | ( | ) |
const ome::compat::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.
bool ome::xml::model::Filter::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.
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 ome::xml::model::ManufacturerSpec::link(), and ome::xml::model::detail::OMEModelObject::logger.
bool ome::xml::model::Filter::linkFilterSetEmissionFilter | ( | const ome::compat::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 filterSetEmissionFilterLinks, and type.
Referenced by ome::xml::model::FilterSet::link().
bool ome::xml::model::Filter::linkFilterSetExcitationFilter | ( | const ome::compat::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 filterSetExcitationFilterLinks, and type.
Referenced by ome::xml::model::FilterSet::link().
bool ome::xml::model::Filter::linkLightPathEmissionFilter | ( | const ome::compat::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 lightPathEmissionFilterLinks, and type.
Referenced by ome::xml::model::LightPath::link().
bool ome::xml::model::Filter::linkLightPathExcitationFilter | ( | const ome::compat::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 lightPathExcitationFilterLinks, and type.
Referenced by ome::xml::model::LightPath::link().
void ome::xml::model::Filter::setFilterWheel | ( | ome::compat::shared_ptr< std::string > & | filterWheel | ) |
Set the FilterWheel property.
filterWheel | the value to set. |
References filterWheel.
Referenced by update().
void ome::xml::model::Filter::setID | ( | const std::string & | id | ) |
void ome::xml::model::Filter::setInstrument | ( | ome::compat::weak_ptr< ome::xml::model::Instrument > & | instrument_BackReference | ) |
Set the Instrument property.
instrument_BackReference | the value to set. |
References instrument.
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::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.
index | the index number of the FilterSetEmissionFilter. |
filterSet_BackReference | the FilterSetEmissionFilter to set. |
std::out_of_range | if the index is invalid. |
References filterSetEmissionFilterLinks.
const ome::compat::weak_ptr< ome::xml::model::FilterSet > & ome::xml::model::Filter::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.
index | the index number of the FilterSetExcitationFilter. |
filterSet_BackReference | the FilterSetExcitationFilter to set. |
std::out_of_range | if the index is invalid. |
References filterSetExcitationFilterLinks.
const ome::compat::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::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.
index | the index number of the LightPathEmissionFilter. |
lightPath_BackReference | the LightPathEmissionFilter to set. |
std::out_of_range | if the index is invalid. |
References lightPathEmissionFilterLinks.
const ome::compat::weak_ptr< ome::xml::model::LightPath > & ome::xml::model::Filter::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.
index | the index number of the LightPathExcitationFilter. |
lightPath_BackReference | the LightPathExcitationFilter to set. |
std::out_of_range | if the index is invalid. |
References lightPathExcitationFilterLinks.
void ome::xml::model::Filter::setTransmittanceRange | ( | ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > & | transmittanceRange | ) |
Set the TransmittanceRange property.
transmittanceRange | the value to set. |
References transmittanceRange.
Referenced by update().
void ome::xml::model::Filter::setType | ( | ome::compat::shared_ptr< ome::xml::model::enums::FilterType > & | type | ) |
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedFilterSetEmissionFilterList | ( | ) | const |
Get size of linked FilterSetEmissionFilter list.
References filterSetEmissionFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::FilterSet, ome::compat::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedFilterSetExcitationFilterList | ( | ) | const |
Get size of linked FilterSetExcitationFilter list.
References filterSetExcitationFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedLightPathEmissionFilterList | ( | ) | const |
Get size of linked LightPathEmissionFilter list.
References lightPathEmissionFilterLinks.
OMEModelObject::indexed_container< ome::xml::model::LightPath, ome::compat::weak_ptr >::type::size_type ome::xml::model::Filter::sizeOfLinkedLightPathExcitationFilterList | ( | ) | const |
Get size of linked LightPathExcitationFilter list.
References lightPathExcitationFilterLinks.
bool ome::xml::model::Filter::unlinkFilterSetEmissionFilter | ( | const ome::compat::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 filterSetEmissionFilterLinks.
bool ome::xml::model::Filter::unlinkFilterSetExcitationFilter | ( | const ome::compat::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 filterSetExcitationFilterLinks.
bool ome::xml::model::Filter::unlinkLightPathEmissionFilter | ( | const ome::compat::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 lightPathEmissionFilterLinks.
bool ome::xml::model::Filter::unlinkLightPathExcitationFilter | ( | const ome::compat::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 lightPathExcitationFilterLinks.
|
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::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::detail::OMEModelObject::stripNamespacePrefix(), 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.
References ome::xml::model::ManufacturerSpec::validElementName().
Referenced by update().