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

Channel model object. More...

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

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

Public Member Functions

 Channel ()
 Default constructor.
 
 Channel (const Channel &copy)
 Copy constructor. More...
 
virtual ~Channel ()
 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< double > getPinholeSize ()
 Get the PinholeSize property. More...
 
const ome::compat::shared_ptr< double > getPinholeSize () const
 Get the PinholeSize property. More...
 
void setPinholeSize (ome::compat::shared_ptr< double > &pinholeSize)
 Set the PinholeSize property. More...
 
ome::compat::shared_ptr< std::string > getName ()
 Get the Name property. More...
 
const ome::compat::shared_ptr< std::string > getName () const
 Get the Name property. More...
 
void setName (ome::compat::shared_ptr< std::string > &name)
 Set the Name property. More...
 
ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionModegetAcquisitionMode ()
 Get the AcquisitionMode property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionModegetAcquisitionMode () const
 Get the AcquisitionMode property. More...
 
void setAcquisitionMode (ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionMode > &acquisitionMode)
 Set the AcquisitionMode property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::ColorgetColor ()
 Get the Color property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::ColorgetColor () const
 Get the Color property. More...
 
void setColor (ome::compat::shared_ptr< ome::xml::model::primitives::Color > &color)
 Set the Color property. More...
 
ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethodgetContrastMethod ()
 Get the ContrastMethod property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethodgetContrastMethod () const
 Get the ContrastMethod property. More...
 
void setContrastMethod (ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethod > &contrastMethod)
 Set the ContrastMethod property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetExcitationWavelength ()
 Get the ExcitationWavelength property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetExcitationWavelength () const
 Get the ExcitationWavelength property. More...
 
void setExcitationWavelength (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &excitationWavelength)
 Set the ExcitationWavelength property. More...
 
ome::compat::shared_ptr< ome::xml::model::enums::IlluminationTypegetIlluminationType ()
 Get the IlluminationType property. More...
 
const ome::compat::shared_ptr< ome::xml::model::enums::IlluminationTypegetIlluminationType () const
 Get the IlluminationType property. More...
 
void setIlluminationType (ome::compat::shared_ptr< ome::xml::model::enums::IlluminationType > &illuminationType)
 Set the IlluminationType property. More...
 
ome::compat::shared_ptr< std::string > getFluor ()
 Get the Fluor property. More...
 
const ome::compat::shared_ptr< std::string > getFluor () const
 Get the Fluor property. More...
 
void setFluor (ome::compat::shared_ptr< std::string > &fluor)
 Set the Fluor property. More...
 
ome::compat::shared_ptr< int32_t > getPockelCellSetting ()
 Get the PockelCellSetting property. More...
 
const ome::compat::shared_ptr< int32_t > getPockelCellSetting () const
 Get the PockelCellSetting property. More...
 
void setPockelCellSetting (ome::compat::shared_ptr< int32_t > &pockelCellSetting)
 Set the PockelCellSetting property. More...
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetEmissionWavelength ()
 Get the EmissionWavelength property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetEmissionWavelength () const
 Get the EmissionWavelength property. More...
 
void setEmissionWavelength (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &emissionWavelength)
 Set the EmissionWavelength property. More...
 
ome::compat::shared_ptr< double > getNDFilter ()
 Get the NDFilter property. More...
 
const ome::compat::shared_ptr< double > getNDFilter () const
 Get the NDFilter property. More...
 
void setNDFilter (ome::compat::shared_ptr< double > &ndFilter)
 Set the NDFilter 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::primitives::PositiveIntegergetSamplesPerPixel ()
 Get the SamplesPerPixel property. More...
 
const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegergetSamplesPerPixel () const
 Get the SamplesPerPixel property. More...
 
void setSamplesPerPixel (ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &samplesPerPixel)
 Set the SamplesPerPixel property. More...
 
ome::compat::shared_ptr< ome::xml::model::LightSourceSettingsgetLightSourceSettings ()
 Get the LightSourceSettings property. More...
 
const ome::compat::shared_ptr< ome::xml::model::LightSourceSettingsgetLightSourceSettings () const
 Get the LightSourceSettings property. More...
 
void setLightSourceSettings (ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &lightSourceSettings)
 Set the LightSourceSettings property. More...
 
ome::compat::shared_ptr< ome::xml::model::DetectorSettingsgetDetectorSettings ()
 Get the DetectorSettings property. More...
 
const ome::compat::shared_ptr< ome::xml::model::DetectorSettingsgetDetectorSettings () const
 Get the DetectorSettings property. More...
 
void setDetectorSettings (ome::compat::shared_ptr< ome::xml::model::DetectorSettings > &detectorSettings)
 Set the DetectorSettings property. More...
 
ome::compat::weak_ptr< ome::xml::model::FilterSetgetLinkedFilterSet ()
 Get linked FilterSet. More...
 
const ome::compat::weak_ptr< ome::xml::model::FilterSetgetLinkedFilterSet () const
 Get linked FilterSet. More...
 
void linkFilterSet (ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
 Link FilterSet. More...
 
void unlinkFilterSet (ome::compat::shared_ptr< ome::xml::model::FilterSet > &filterSet)
 Unlink FilterSet. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList () const
 Get size of linked Annotation list. More...
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList () const
 Get the linked Annotation list. More...
 
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
 Get linked Annotation. More...
 
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation (OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
 Set linked Annotation. More...
 
bool linkAnnotation (const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
 Link Annotation. More...
 
bool unlinkAnnotation (const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
 Unlink Annotation. More...
 
ome::compat::shared_ptr< ome::xml::model::LightPathgetLightPath ()
 Get the LightPath property. More...
 
const ome::compat::shared_ptr< ome::xml::model::LightPathgetLightPath () const
 Get the LightPath property. More...
 
void setLightPath (ome::compat::shared_ptr< ome::xml::model::LightPath > &lightPath)
 Set the LightPath property. More...
 
ome::compat::weak_ptr< ome::xml::model::PixelsgetPixels ()
 Get the Pixels property. More...
 
const ome::compat::weak_ptr< ome::xml::model::PixelsgetPixels () const
 Get the Pixels property. More...
 
void setPixels (ome::compat::weak_ptr< ome::xml::model::Pixels > &pixels_BackReference)
 Set the Pixels property. 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::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< Channelcreate (const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
 Create a Channel 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< double > pinholeSize
 PinholeSize property.
 
ome::compat::shared_ptr< std::string > name
 Name property.
 
ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionModeacquisitionMode
 AcquisitionMode property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::Colorcolor
 Color property.
 
ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethodcontrastMethod
 ContrastMethod property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegerexcitationWavelength
 ExcitationWavelength property.
 
ome::compat::shared_ptr< ome::xml::model::enums::IlluminationTypeilluminationType
 IlluminationType property.
 
ome::compat::shared_ptr< std::string > fluor
 Fluor property.
 
ome::compat::shared_ptr< int32_t > pockelCellSetting
 PockelCellSetting property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegeremissionWavelength
 EmissionWavelength property.
 
ome::compat::shared_ptr< double > ndFilter
 NDFilter property.
 
std::string id
 ID property.
 
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveIntegersamplesPerPixel
 SamplesPerPixel property.
 
ome::compat::shared_ptr< ome::xml::model::LightSourceSettingslightSourceSettings
 LightSourceSettings property.
 
ome::compat::shared_ptr< ome::xml::model::DetectorSettingsdetectorSettings
 DetectorSettings property.
 
ome::compat::weak_ptr< ome::xml::model::FilterSetfilterSet
 FilterSetRef reference.
 
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type annotationLinks
 AnnotationRef reference (occurs more than once)
 
ome::compat::shared_ptr< ome::xml::model::LightPathlightPath
 LightPath property.
 
ome::compat::weak_ptr< ome::xml::model::Pixelspixels
 Pixels_BackReference back reference.
 

Additional Inherited Members

- Protected Attributes inherited from ome::xml::model::detail::OMEModelObject
ome::common::Logger logger
 Message logger.
 

Detailed Description

Channel model object.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
copythe Channel to copy.

Member Function Documentation

common::xml::dom::Element ome::xml::model::Channel::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.

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

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

common::xml::dom::Element ome::xml::model::Channel::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.

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

References acquisitionMode, annotationLinks, ome::common::xml::dom::Node::appendChild(), ome::xml::model::detail::OMEModelObject::asXMLElementInternal(), color, contrastMethod, ome::common::xml::dom::Document::createElementNS(), detectorSettings, emissionWavelength, excitationWavelength, filterSet, fluor, id, illuminationType, lightPath, lightSourceSettings, name, ndFilter, pinholeSize, pockelCellSetting, samplesPerPixel, and ome::common::xml::dom::Element::setAttribute().

Referenced by asXMLElement().

+ Here is the caller graph for this function:

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

Create a Channel 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::Pixels::update().

+ Here is the caller graph for this function:

const std::string & ome::xml::model::Channel::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.

ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionMode > ome::xml::model::Channel::getAcquisitionMode ( )

Get the AcquisitionMode property.

Returns
the AcquisitionMode property.

References acquisitionMode.

const ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionMode > ome::xml::model::Channel::getAcquisitionMode ( ) const

Get the AcquisitionMode property.

Returns
the AcquisitionMode property.

References acquisitionMode.

ome::compat::shared_ptr< ome::xml::model::primitives::Color > ome::xml::model::Channel::getColor ( )

Get the Color property.

Returns
the Color property.

References color.

const ome::compat::shared_ptr< ome::xml::model::primitives::Color > ome::xml::model::Channel::getColor ( ) const

Get the Color property.

Returns
the Color property.

References color.

ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethod > ome::xml::model::Channel::getContrastMethod ( )

Get the ContrastMethod property.

Returns
the ContrastMethod property.

References contrastMethod.

const ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethod > ome::xml::model::Channel::getContrastMethod ( ) const

Get the ContrastMethod property.

Returns
the ContrastMethod property.

References contrastMethod.

ome::compat::shared_ptr< ome::xml::model::DetectorSettings > ome::xml::model::Channel::getDetectorSettings ( )

Get the DetectorSettings property.

Returns
the DetectorSettings property.

References detectorSettings.

const ome::compat::shared_ptr< ome::xml::model::DetectorSettings > ome::xml::model::Channel::getDetectorSettings ( ) const

Get the DetectorSettings property.

Returns
the DetectorSettings property.

References detectorSettings.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Channel::getEmissionWavelength ( )

Get the EmissionWavelength property.

Returns
the EmissionWavelength property.

References emissionWavelength.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Channel::getEmissionWavelength ( ) const

Get the EmissionWavelength property.

Returns
the EmissionWavelength property.

References emissionWavelength.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Channel::getExcitationWavelength ( )

Get the ExcitationWavelength property.

Returns
the ExcitationWavelength property.

References excitationWavelength.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Channel::getExcitationWavelength ( ) const

Get the ExcitationWavelength property.

Returns
the ExcitationWavelength property.

References excitationWavelength.

ome::compat::shared_ptr< std::string > ome::xml::model::Channel::getFluor ( )

Get the Fluor property.

Returns
the Fluor property.

References fluor.

const ome::compat::shared_ptr< std::string > ome::xml::model::Channel::getFluor ( ) const

Get the Fluor property.

Returns
the Fluor property.

References fluor.

const std::string & ome::xml::model::Channel::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::shared_ptr< ome::xml::model::enums::IlluminationType > ome::xml::model::Channel::getIlluminationType ( )

Get the IlluminationType property.

Returns
the IlluminationType property.

References illuminationType.

const ome::compat::shared_ptr< ome::xml::model::enums::IlluminationType > ome::xml::model::Channel::getIlluminationType ( ) const

Get the IlluminationType property.

Returns
the IlluminationType property.

References illuminationType.

ome::compat::shared_ptr< ome::xml::model::LightPath > ome::xml::model::Channel::getLightPath ( )

Get the LightPath property.

Returns
the LightPath property.

References lightPath.

const ome::compat::shared_ptr< ome::xml::model::LightPath > ome::xml::model::Channel::getLightPath ( ) const

Get the LightPath property.

Returns
the LightPath property.

References lightPath.

ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > ome::xml::model::Channel::getLightSourceSettings ( )

Get the LightSourceSettings property.

Returns
the LightSourceSettings property.

References lightSourceSettings.

const ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > ome::xml::model::Channel::getLightSourceSettings ( ) const

Get the LightSourceSettings property.

Returns
the LightSourceSettings property.

References lightSourceSettings.

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Channel::getLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type  index) const

Get linked Annotation.

Parameters
indexthe index number of the Annotation.
Returns
a weak pointer to the Annotation.
Exceptions
std::out_of_rangeif the index is invalid.

References annotationLinks.

OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type ome::xml::model::Channel::getLinkedAnnotationList ( ) const

Get the linked Annotation list.

Returns
a reference to the list.

References annotationLinks.

ome::compat::weak_ptr< ome::xml::model::FilterSet > ome::xml::model::Channel::getLinkedFilterSet ( )

Get linked FilterSet.

Returns
the linked FilterSet. The pointer may be null.

References filterSet.

const ome::compat::weak_ptr< ome::xml::model::FilterSet > ome::xml::model::Channel::getLinkedFilterSet ( ) const

Get linked FilterSet.

Returns
the linked FilterSet. The pointer may be null.

References filterSet.

ome::compat::shared_ptr< std::string > ome::xml::model::Channel::getName ( )

Get the Name property.

Returns
the Name property.

References name.

const ome::compat::shared_ptr< std::string > ome::xml::model::Channel::getName ( ) const

Get the Name property.

Returns
the Name property.

References name.

ome::compat::shared_ptr< double > ome::xml::model::Channel::getNDFilter ( )

Get the NDFilter property.

Returns
the NDFilter property.

References ndFilter.

const ome::compat::shared_ptr< double > ome::xml::model::Channel::getNDFilter ( ) const

Get the NDFilter property.

Returns
the NDFilter property.

References ndFilter.

ome::compat::shared_ptr< double > ome::xml::model::Channel::getPinholeSize ( )

Get the PinholeSize property.

Returns
the PinholeSize property.

References pinholeSize.

const ome::compat::shared_ptr< double > ome::xml::model::Channel::getPinholeSize ( ) const

Get the PinholeSize property.

Returns
the PinholeSize property.

References pinholeSize.

ome::compat::weak_ptr< ome::xml::model::Pixels > ome::xml::model::Channel::getPixels ( )

Get the Pixels property.

Returns
the Pixels property.

References pixels.

const ome::compat::weak_ptr< ome::xml::model::Pixels > ome::xml::model::Channel::getPixels ( ) const

Get the Pixels property.

Returns
the Pixels property.

References pixels.

ome::compat::shared_ptr< int32_t > ome::xml::model::Channel::getPockelCellSetting ( )

Get the PockelCellSetting property.

Returns
the PockelCellSetting property.

References pockelCellSetting.

const ome::compat::shared_ptr< int32_t > ome::xml::model::Channel::getPockelCellSetting ( ) const

Get the PockelCellSetting property.

Returns
the PockelCellSetting property.

References pockelCellSetting.

ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Channel::getSamplesPerPixel ( )

Get the SamplesPerPixel property.

Returns
the SamplesPerPixel property.

References samplesPerPixel.

const ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > ome::xml::model::Channel::getSamplesPerPixel ( ) const

Get the SamplesPerPixel property.

Returns
the SamplesPerPixel property.

References samplesPerPixel.

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

Get the XML namespace for this model object.

Returns
the XML namespace.

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

bool ome::xml::model::Channel::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.
Todo:
This bit is silly; why do we have two dynamic_casts here.
Todo:
This bit is silly; why do we have two dynamic_casts here.

References annotationLinks, filterSet, ome::xml::model::detail::OMEModelObject::link(), ome::xml::model::FilterSet::linkChannel(), ome::xml::model::Annotation::linkChannel(), ome::xml::model::detail::OMEModelObject::logger, and name.

bool ome::xml::model::Channel::linkAnnotation ( const ome::compat::shared_ptr< ome::xml::model::Annotation > &  annotation)

Link Annotation.

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

References annotationLinks.

void ome::xml::model::Channel::linkFilterSet ( ome::compat::shared_ptr< ome::xml::model::FilterSet > &  filterSet)

Link FilterSet.

Parameters
filterSetthe FilterSet to link.

References filterSet.

void ome::xml::model::Channel::setAcquisitionMode ( ome::compat::shared_ptr< ome::xml::model::enums::AcquisitionMode > &  acquisitionMode)

Set the AcquisitionMode property.

Parameters
acquisitionModethe value to set.

References acquisitionMode.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setColor ( ome::compat::shared_ptr< ome::xml::model::primitives::Color > &  color)

Set the Color property.

Parameters
colorthe value to set.

References color.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setContrastMethod ( ome::compat::shared_ptr< ome::xml::model::enums::ContrastMethod > &  contrastMethod)

Set the ContrastMethod property.

Parameters
contrastMethodthe value to set.

References contrastMethod.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setDetectorSettings ( ome::compat::shared_ptr< ome::xml::model::DetectorSettings > &  detectorSettings)

Set the DetectorSettings property.

Parameters
detectorSettingsthe value to set.

References detectorSettings.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setEmissionWavelength ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  emissionWavelength)

Set the EmissionWavelength property.

Parameters
emissionWavelengththe value to set.

References emissionWavelength.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setExcitationWavelength ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  excitationWavelength)

Set the ExcitationWavelength property.

Parameters
excitationWavelengththe value to set.

References excitationWavelength.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setFluor ( ome::compat::shared_ptr< std::string > &  fluor)

Set the Fluor property.

Parameters
fluorthe value to set.

References fluor.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::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::Channel::setIlluminationType ( ome::compat::shared_ptr< ome::xml::model::enums::IlluminationType > &  illuminationType)

Set the IlluminationType property.

Parameters
illuminationTypethe value to set.

References illuminationType.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setLightPath ( ome::compat::shared_ptr< ome::xml::model::LightPath > &  lightPath)

Set the LightPath property.

Parameters
lightPaththe value to set.

References lightPath.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setLightSourceSettings ( ome::compat::shared_ptr< ome::xml::model::LightSourceSettings > &  lightSourceSettings)

Set the LightSourceSettings property.

Parameters
lightSourceSettingsthe value to set.

References lightSourceSettings.

Referenced by update().

+ Here is the caller graph for this function:

const ome::compat::weak_ptr< ome::xml::model::Annotation > & ome::xml::model::Channel::setLinkedAnnotation ( OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type  index,
const ome::compat::shared_ptr< ome::xml::model::Annotation > &  annotation 
)

Set linked Annotation.

Note
The index must be valid.
Parameters
indexthe index number of the Annotation.
annotationthe Annotation to set.
Returns
a weak pointer to the Annotation.
Exceptions
std::out_of_rangeif the index is invalid.

References annotationLinks.

void ome::xml::model::Channel::setName ( ome::compat::shared_ptr< std::string > &  name)

Set the Name property.

Parameters
namethe value to set.

References name.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setNDFilter ( ome::compat::shared_ptr< double > &  ndFilter)

Set the NDFilter property.

Parameters
ndFilterthe value to set.

References ndFilter.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setPinholeSize ( ome::compat::shared_ptr< double > &  pinholeSize)

Set the PinholeSize property.

Parameters
pinholeSizethe value to set.

References pinholeSize.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setPixels ( ome::compat::weak_ptr< ome::xml::model::Pixels > &  pixels_BackReference)

Set the Pixels property.

Parameters
pixels_BackReferencethe value to set.

References pixels.

void ome::xml::model::Channel::setPockelCellSetting ( ome::compat::shared_ptr< int32_t > &  pockelCellSetting)

Set the PockelCellSetting property.

Parameters
pockelCellSettingthe value to set.

References pockelCellSetting.

Referenced by update().

+ Here is the caller graph for this function:

void ome::xml::model::Channel::setSamplesPerPixel ( ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &  samplesPerPixel)

Set the SamplesPerPixel property.

Parameters
samplesPerPixelthe value to set.

References samplesPerPixel.

Referenced by update().

+ Here is the caller graph for this function:

OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type ome::xml::model::Channel::sizeOfLinkedAnnotationList ( ) const

Get size of linked Annotation list.

Returns
the size of the list.

References annotationLinks.

bool ome::xml::model::Channel::unlinkAnnotation ( const ome::compat::shared_ptr< ome::xml::model::Annotation > &  annotation)

Unlink Annotation.

Parameters
annotationthe Annotation to unlink.
Returns
true if the Annotation was unlinked, otherwise false if the Annotation 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 annotationLinks.

void ome::xml::model::Channel::unlinkFilterSet ( ome::compat::shared_ptr< ome::xml::model::FilterSet > &  filterSet)

Unlink FilterSet.

Parameters
filterSetthe FilterSet to unlink.
Todo:
This method is fairly pointless since it's equivalent to linking a null pointer. It could call link(0) internally.
void ome::xml::model::Channel::update ( const common::xml::dom::Element element,
ome::xml::model::OMEModel model 
)
virtual
bool ome::xml::model::Channel::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::detail::OMEModelObject::validElementName().

Referenced by update().

+ Here is the caller graph for this function:


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