bioformats  5.1.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ome::xml::model::Filter Class Reference

Filter model object. More...

#include <ome/xml/model/Filter.h>

+ Inheritance diagram for ome::xml::model::Filter:
+ Collaboration diagram for ome::xml::model::Filter:

Public Member Functions

 Filter ()
 Default constructor.
 
 Filter (const Filter &copy)
 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::FilterTypegetType ()
 Get the Type property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::FilterTypegetType () 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::TransmittanceRangegetTransmittanceRange ()
 Get the TransmittanceRange property. More...
 
const ome::compat::shared_ptr< ome::xml::model::TransmittanceRangegetTransmittanceRange () 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::InstrumentgetInstrument ()
 Get the Instrument property. More...
 
const ome::compat::weak_ptr< ome::xml::model::InstrumentgetInstrument () 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)
 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< Filtercreate (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::ElementgetChildrenByTagName (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)
 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::FilterTypetype
 Type property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< ome::xml::model::TransmittanceRangetransmittanceRange
 TransmittanceRange property.
 
ome::compat::weak_ptr< ome::xml::model::Instrumentinstrument
 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.
 

Detailed Description

Filter model object.

Constructor & Destructor Documentation

ome::xml::model::Filter::Filter ( const Filter copy)

Copy constructor.

Parameters
copythe Filter to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::Filter::asXMLElement ( common::xml::dom::Document document) const
virtual

Transform the object hierarchy rooted at this element to XML.

Parameters
documentdocument for element creation
Returns
an XML DOM tree root element for this model object.

Reimplemented from ome::xml::model::ManufacturerSpec.

References asXMLElementInternal(), and ome::common::xml::dom::Document::createElementNS().

common::xml::dom::Element ome::xml::model::Filter::asXMLElementInternal ( common::xml::dom::Document document,
common::xml::dom::Element element 
) const
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.

Parameters
documentXML document for element creation.
elementXML element for setting model data.
Returns
an XML DOM tree root element for this model object.

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().

+ Here is the caller graph for this function:

ome::compat::shared_ptr< Filter > ome::xml::model::Filter::create ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
static

Create a Filter model object from DOM element.

Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif there is an error instantiating an enumeration during model object creation, or ModelException if there are any consistency or validity errors found during processing.
Returns
a new model object.

Referenced by ome::xml::model::Instrument::update().

+ Here is the caller graph for this function:

const std::string & ome::xml::model::Filter::elementName ( ) const
virtual

Get the element name of this model object.

This will be the most-derived class name.

Returns
the element type.

Implements ome::xml::model::OMEModelObject.

References type.

ome::compat::shared_ptr< std::string > ome::xml::model::Filter::getFilterWheel ( )

Get the FilterWheel property.

Returns
the FilterWheel property.

References filterWheel.

const ome::compat::shared_ptr< std::string > ome::xml::model::Filter::getFilterWheel ( ) const

Get the FilterWheel property.

Returns
the FilterWheel property.

References filterWheel.

const std::string & ome::xml::model::Filter::getID ( ) const

Get the ID property.

Returns
the ID property.

References id.

Referenced by update().

+ Here is the caller graph for this function:

ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Filter::getInstrument ( )

Get the Instrument property.

Returns
the Instrument property.

References instrument.

const ome::compat::weak_ptr< ome::xml::model::Instrument > ome::xml::model::Filter::getInstrument ( ) const

Get the Instrument property.

Returns
the Instrument property.

References instrument.

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.

Parameters
indexthe index number of the FilterSetEmissionFilter.
Returns
a weak pointer to the FilterSetEmissionFilter.
Exceptions
std::out_of_rangeif 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.

Returns
a reference to the 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.

Parameters
indexthe index number of the FilterSetExcitationFilter.
Returns
a weak pointer to the FilterSetExcitationFilter.
Exceptions
std::out_of_rangeif 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.

Returns
a reference to the 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.

Parameters
indexthe index number of the LightPathEmissionFilter.
Returns
a weak pointer to the LightPathEmissionFilter.
Exceptions
std::out_of_rangeif 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.

Returns
a reference to the 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.

Parameters
indexthe index number of the LightPathExcitationFilter.
Returns
a weak pointer to the LightPathExcitationFilter.
Exceptions
std::out_of_rangeif 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.

Returns
a reference to the list.

References lightPathExcitationFilterLinks.

ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > ome::xml::model::Filter::getTransmittanceRange ( )

Get the TransmittanceRange property.

Returns
the TransmittanceRange property.

References transmittanceRange.

const ome::compat::shared_ptr< ome::xml::model::TransmittanceRange > ome::xml::model::Filter::getTransmittanceRange ( ) const

Get the TransmittanceRange property.

Returns
the TransmittanceRange property.

References transmittanceRange.

ome::compat::shared_ptr< ome::xml::model::enums::FilterType > ome::xml::model::Filter::getType ( )

Get the Type property.

Returns
the Type property.

References type.

const ome::compat::shared_ptr< ome::xml::model::enums::FilterType > ome::xml::model::Filter::getType ( ) const

Get the Type property.

Returns
the Type property.

References type.

const std::string & ome::xml::model::Filter::getXMLNamespace ( ) const
virtual

Get the XML namespace for this model object.

Returns
the XML namespace.

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.

Parameters
referencetype 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.
objectModel object to link to.
Returns
true if this model object was able to handle the reference, otherwise false.
Todo:
the use of reference to provide type information for the type of object is unconventional and quite possibly unnecessary–a simple string or type_info would suffice for what it's being used for, if it's needed at all. Is this true for all cases? The implementation also needs to do strict checking of the object type; it's not currently failing if it's of the wrong type. This applies to all generated model objects implementing this interface.

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.

Parameters
filterSet_BackReferencethe FilterSetEmissionFilter to link.
Returns
true if the object was added to the internal filterSetEmissionFilterLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References filterSetEmissionFilterLinks, and type.

Referenced by ome::xml::model::FilterSet::link().

+ Here is the caller graph for this function:

bool ome::xml::model::Filter::linkFilterSetExcitationFilter ( const ome::compat::shared_ptr< ome::xml::model::FilterSet > &  filterSet_BackReference)

Link FilterSetExcitationFilter.

Parameters
filterSet_BackReferencethe FilterSetExcitationFilter to link.
Returns
true if the object was added to the internal filterSetExcitationFilterLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References filterSetExcitationFilterLinks, and type.

Referenced by ome::xml::model::FilterSet::link().

+ Here is the caller graph for this function:

bool ome::xml::model::Filter::linkLightPathEmissionFilter ( const ome::compat::shared_ptr< ome::xml::model::LightPath > &  lightPath_BackReference)

Link LightPathEmissionFilter.

Parameters
lightPath_BackReferencethe LightPathEmissionFilter to link.
Returns
true if the object was added to the internal lightPathEmissionFilterLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References lightPathEmissionFilterLinks, and type.

Referenced by ome::xml::model::LightPath::link().

+ Here is the caller graph for this function:

bool ome::xml::model::Filter::linkLightPathExcitationFilter ( const ome::compat::shared_ptr< ome::xml::model::LightPath > &  lightPath_BackReference)

Link LightPathExcitationFilter.

Parameters
lightPath_BackReferencethe LightPathExcitationFilter to link.
Returns
true if the object was added to the internal lightPathExcitationFilterLinks list, otherwise false.
Todo:
Why have a return value here; what is it used for? Is this an artifact of the Java API?

References lightPathExcitationFilterLinks, and type.

Referenced by ome::xml::model::LightPath::link().

+ Here is the caller graph for this function:

void ome::xml::model::Filter::setFilterWheel ( ome::compat::shared_ptr< std::string > &  filterWheel)

Set the FilterWheel property.

Parameters
filterWheelthe value to set.

References filterWheel.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Filter::setID ( const std::string &  id)

Set the ID property.

Parameters
idthe value to set.

References id.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Filter::setInstrument ( ome::compat::weak_ptr< ome::xml::model::Instrument > &  instrument_BackReference)

Set the Instrument property.

Parameters
instrument_BackReferencethe 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.

Note
The index must be valid.
Parameters
indexthe index number of the FilterSetEmissionFilter.
filterSet_BackReferencethe FilterSetEmissionFilter to set.
Returns
a weak pointer to the FilterSetEmissionFilter.
Exceptions
std::out_of_rangeif 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.

Note
The index must be valid.
Parameters
indexthe index number of the FilterSetExcitationFilter.
filterSet_BackReferencethe FilterSetExcitationFilter to set.
Returns
a weak pointer to the FilterSetExcitationFilter.
Exceptions
std::out_of_rangeif 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.

Note
The index must be valid.
Parameters
indexthe index number of the LightPathEmissionFilter.
lightPath_BackReferencethe LightPathEmissionFilter to set.
Returns
a weak pointer to the LightPathEmissionFilter.
Exceptions
std::out_of_rangeif 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.

Note
The index must be valid.
Parameters
indexthe index number of the LightPathExcitationFilter.
lightPath_BackReferencethe LightPathExcitationFilter to set.
Returns
a weak pointer to the LightPathExcitationFilter.
Exceptions
std::out_of_rangeif 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.

Parameters
transmittanceRangethe value to set.

References transmittanceRange.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Filter::setType ( ome::compat::shared_ptr< ome::xml::model::enums::FilterType > &  type)

Set the Type property.

Parameters
typethe value to set.

References type.

Referenced by update().

+ Here is the caller graph for this function:

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.

Returns
the size of the 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.

Returns
the size of the 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.

Returns
the size of the 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.

Returns
the size of the list.

References lightPathExcitationFilterLinks.

bool ome::xml::model::Filter::unlinkFilterSetEmissionFilter ( const ome::compat::shared_ptr< ome::xml::model::FilterSet > &  filterSet_BackReference)

Unlink FilterSetEmissionFilter.

Parameters
filterSet_BackReferencethe FilterSetEmissionFilter to unlink.
Returns
true if the FilterSetEmissionFilter was unlinked, otherwise false if the FilterSetEmissionFilter was not linked and could hence not be unlinked.
Todo:

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.

Parameters
filterSet_BackReferencethe FilterSetExcitationFilter to unlink.
Returns
true if the FilterSetExcitationFilter was unlinked, otherwise false if the FilterSetExcitationFilter was not linked and could hence not be unlinked.
Todo:

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.

Parameters
lightPath_BackReferencethe LightPathEmissionFilter to unlink.
Returns
true if the LightPathEmissionFilter was unlinked, otherwise false if the LightPathEmissionFilter was not linked and could hence not be unlinked.
Todo:

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.

Parameters
lightPath_BackReferencethe LightPathExcitationFilter to unlink.
Returns
true if the LightPathExcitationFilter was unlinked, otherwise false if the LightPathExcitationFilter was not linked and could hence not be unlinked.
Todo:

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.

void ome::xml::model::Filter::update ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
virtual

Update the object hierarchy recursively from an XML DOM tree.

Note
No properties are removed, only added or updated.
Parameters
elementroot of the XML DOM tree to from which to construct the model object graph.
modelhandler for the OME model used to track instances and references seen during the update.
Exceptions
EnumerationExceptionif 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().

bool ome::xml::model::Filter::validElementName ( const std::string &  name) const
virtual

Check if a given element name is valid for processing by this model object.

Used for processing nodes when interitance is involved.

Parameters
namethe element name to check.
Returns
true if valid, false if invalid.

Implements ome::xml::model::detail::OMEModelObject.

References ome::xml::model::ManufacturerSpec::validElementName().

Referenced by update().

+ Here is the caller graph for this function:


The documentation for this class was generated from the following files: