Inscoper::NBO::FilterSet

Represents the XML element FilterSet. More...

#include <FilterSet.h>

Inherits from NBOBaseClass

Public Functions

	Name
	FilterSet()
	~FilterSet()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::FilterSetID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
FilterSetID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setName(const Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the optional Name attribute is present.
void	setExcitationFilterRef(const Inscoper::NBO::ExcitationFilterRefPtr & value, bool validate =true) Sets the value of the ExcitationFilterRef element.
Inscoper::NBO::ExcitationFilterRefPtr	getExcitationFilterRef() const Returns the value of the ExcitationFilterRef element.
void	resetExcitationFilterRef() Resets the ExcitationFilterRef element to an unset state.
bool	hasExcitationFilterRef() const Checks whether the optional ExcitationFilterRef element is present.
void	setStandardDichroicRef(const Inscoper::NBO::StandardDichroicRefPtr & value, bool validate =true) Sets the value of the StandardDichroicRef element.
Inscoper::NBO::StandardDichroicRefPtr	getStandardDichroicRef() const Returns the value of the StandardDichroicRef element.
void	resetStandardDichroicRef() Resets the StandardDichroicRef element to an unset state.
bool	hasStandardDichroicRef() const Checks whether the optional StandardDichroicRef element is present.
void	setEmissionFilterRef(const Inscoper::NBO::EmissionFilterRefPtr & value, bool validate =true) Sets the value of the EmissionFilterRef element.
Inscoper::NBO::EmissionFilterRefPtr	getEmissionFilterRef() const Returns the value of the EmissionFilterRef element.
void	resetEmissionFilterRef() Resets the EmissionFilterRef element to an unset state.
bool	hasEmissionFilterRef() const Checks whether the optional EmissionFilterRef element is present.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< FilterSet >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a FilterSet.

Detailed Description

class Inscoper::NBO::FilterSet;

Represents the XML element FilterSet.

This element represents a FilterSet that was used for the acquisition of this Channel. A Filter Set is typically composed of one Excitation Filter, one Emission Filter and a Dichroic. They might either be pre-assembled by the Manufacturer and purchased as a whole or they can be custom assembled on site depending on the needs of the user.

Public Functions Documentation

function FilterSet

function ~FilterSet

function getTypeName

function getXMLName

function getNBOType

function getChildren

function getSubElements

function fromJsonFile

function fromJsonString

function fromXmlFile

function fromXmlString

function toXmlFile

function toXmlString

function setID

function getID

function resetID

function hasID

function setName

function getName

function resetName

function hasName

function setExcitationFilterRef

function getExcitationFilterRef

function resetExcitationFilterRef

function hasExcitationFilterRef

function setStandardDichroicRef

function getStandardDichroicRef

function resetStandardDichroicRef

function hasStandardDichroicRef

function setEmissionFilterRef

function getEmissionFilterRef

function resetEmissionFilterRef

function hasEmissionFilterRef

function setAnnotationRef

function getAnnotationRef

function resetAnnotationRef

function hasAnnotationRef

function fromBase