Inscoper::NBO::GenericDichroic¶

Represents the XML element GenericDichroic. More...

#include <GenericDichroic.h>

Inherits from Inscoper::NBO::Dichroic_Type, Inscoper::NBO::MirroringDevice_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	GenericDichroic()
	~GenericDichroic()
virtual 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.
std::shared_ptr< GenericDichroic >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a GenericDichroic.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Dichroic_Type

	Name
	Dichroic_Type()
	~Dichroic_Type()
void	setType(const Inscoper::NBO::FilterType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
FilterType_TypePtr	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the optional Type attribute is present.
void	setCoatingMethod(const Inscoper::NBO::CoatingMethod_TypePtr & value, bool validate =true) Sets the value of the CoatingMethod attribute.
CoatingMethod_TypePtr	getCoatingMethod() const Returns the value of the CoatingMethod attribute.
void	resetCoatingMethod() Resets the CoatingMethod attribute to an unset state.
bool	hasCoatingMethod() const Checks whether the optional CoatingMethod attribute is present.
void	setLightPathLocation(const Inscoper::NBO::LightPathLocationOptions_TypePtr & value, bool validate =true) Sets the value of the LightPathLocation attribute.
LightPathLocationOptions_TypePtr	getLightPathLocation() const Returns the value of the LightPathLocation attribute.
void	resetLightPathLocation() Resets the LightPathLocation attribute to an unset state.
bool	hasLightPathLocation() const Checks whether the optional LightPathLocation attribute is present.
void	setTechnology(const Inscoper::NBO::FilterTechnologyType_TypePtr & value, bool validate =true) Sets the value of the Technology attribute.
FilterTechnologyType_TypePtr	getTechnology() const Returns the value of the Technology attribute.
void	resetTechnology() Resets the Technology attribute to an unset state.
bool	hasTechnology() const Checks whether the optional Technology attribute is present.
void	setAttenuationMethod(const Inscoper::NBO::AttenuationMethodType_TypePtr & value, bool validate =true) Sets the value of the AttenuationMethod attribute.
AttenuationMethodType_TypePtr	getAttenuationMethod() const Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
bool	hasAttenuationMethod() const Checks whether the optional AttenuationMethod attribute is present.
void	setAttenuationCoefficient(const float & value, bool validate =true) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() const Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
bool	hasAttenuationCoefficient() const Checks whether the AttenuationCoefficient attribute is present.
void	setThickness(const float & value, bool validate =true) Sets the value of the Thickness attribute.
float	getThickness() const Returns the value of the Thickness attribute.
void	resetThickness() Resets the Thickness attribute to an unset state.
bool	hasThickness() const Checks whether the Thickness attribute is present.
void	setThicknessUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ThicknessUnit attribute.
UnitsLength_TypePtr	getThicknessUnit() const Returns the value of the ThicknessUnit attribute.
void	resetThicknessUnit() Resets the ThicknessUnit attribute to an unset state.
bool	hasThicknessUnit() const Checks whether the optional ThicknessUnit attribute is present.
void	setPolarization(const Inscoper::NBO::FilterPolarizationType_TypePtr & value, bool validate =true) Sets the value of the Polarization attribute.
FilterPolarizationType_TypePtr	getPolarization() const Returns the value of the Polarization attribute.
void	resetPolarization() Resets the Polarization attribute to an unset state.
bool	hasPolarization() const Checks whether the optional Polarization attribute is present.
void	setTransmittanceProfileFile_List(const std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > & value, bool validate =true) Sets the list of TransmittanceProfileFile elements.
std::vector< Inscoper::NBO::TransmittanceProfileFilePtr >	getTransmittanceProfileFile_List() const Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(const Inscoper::NBO::TransmittanceProfileFilePtr & value, bool validate =true) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setReflectanceProfileFile_List(const std::vector< Inscoper::NBO::ReflectanceProfileFilePtr > & value, bool validate =true) Sets the list of ReflectanceProfileFile elements.
std::vector< Inscoper::NBO::ReflectanceProfileFilePtr >	getReflectanceProfileFile_List() const Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(const Inscoper::NBO::ReflectanceProfileFilePtr & value, bool validate =true) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
void	setTransmittanceRange_List(const std::vector< Inscoper::NBO::TransmittanceRangePtr > & value, bool validate =true) Sets the list of TransmittanceRange elements.
std::vector< Inscoper::NBO::TransmittanceRangePtr >	getTransmittanceRange_List() const Returns the list of TransmittanceRange elements.
void	addToTransmittanceRange_List(const Inscoper::NBO::TransmittanceRangePtr & value, bool validate =true) Adds a new TransmittanceRange element to this object.
void	clearTransmittanceRange_List() Clear the list of TransmittanceRange.
void	setReflectanceRange_List(const std::vector< Inscoper::NBO::ReflectanceRangePtr > & value, bool validate =true) Sets the list of ReflectanceRange elements.
std::vector< Inscoper::NBO::ReflectanceRangePtr >	getReflectanceRange_List() const Returns the list of ReflectanceRange elements.
void	addToReflectanceRange_List(const Inscoper::NBO::ReflectanceRangePtr & value, bool validate =true) Adds a new ReflectanceRange element to this object.
void	clearReflectanceRange_List() Clear the list of ReflectanceRange.

Public Functions inherited from Inscoper::NBO::MirroringDevice_Type

	Name
	MirroringDevice_Type()
	~MirroringDevice_Type()
void	setID(const Inscoper::NBO::MirrorID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
MirrorID_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	setOpticsHolderPosition(const std::string & value, bool validate =true) Sets the value of the OpticsHolderPosition attribute.
std::string	getOpticsHolderPosition() const Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
bool	hasOpticsHolderPosition() const Checks whether the OpticsHolderPosition attribute is present.
void	setMirrorType(const Inscoper::NBO::MirrorType_TypePtr & value, bool validate =true) Sets the value of the MirrorType attribute.
MirrorType_TypePtr	getMirrorType() const Returns the value of the MirrorType attribute.
void	resetMirrorType() Resets the MirrorType attribute to an unset state.
bool	hasMirrorType() const Checks whether the optional MirrorType attribute is present.
void	setGeometry(const Inscoper::NBO::MirrorGeometry_TypePtr & value, bool validate =true) Sets the value of the Geometry attribute.
MirrorGeometry_TypePtr	getGeometry() const Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
bool	hasGeometry() const Checks whether the optional Geometry attribute is present.
void	setDiameter(const float & value, bool validate =true) Sets the value of the Diameter attribute.
float	getDiameter() const Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
bool	hasDiameter() const Checks whether the Diameter attribute is present.
void	setDiameterUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the DiameterUnit attribute.
UnitsLength_TypePtr	getDiameterUnit() const Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
bool	hasDiameterUnit() const Checks whether the optional DiameterUnit attribute is present.
void	setRadiusOfCurvature(const float & value, bool validate =true) Sets the value of the RadiusOfCurvature attribute.
float	getRadiusOfCurvature() const Returns the value of the RadiusOfCurvature attribute.
void	resetRadiusOfCurvature() Resets the RadiusOfCurvature attribute to an unset state.
bool	hasRadiusOfCurvature() const Checks whether the RadiusOfCurvature attribute is present.
void	setRadiusOfCurvatureUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the RadiusOfCurvatureUnit attribute.
UnitsLength_TypePtr	getRadiusOfCurvatureUnit() const Returns the value of the RadiusOfCurvatureUnit attribute.
void	resetRadiusOfCurvatureUnit() Resets the RadiusOfCurvatureUnit attribute to an unset state.
bool	hasRadiusOfCurvatureUnit() const Checks whether the optional RadiusOfCurvatureUnit attribute is present.
void	setAngleOfIncidence(const float & value, bool validate =true) Sets the value of the AngleOfIncidence attribute.
float	getAngleOfIncidence() const Returns the value of the AngleOfIncidence attribute.
void	resetAngleOfIncidence() Resets the AngleOfIncidence attribute to an unset state.
bool	hasAngleOfIncidence() const Checks whether the AngleOfIncidence attribute is present.
void	setAngleOfIncidenceUnit(const Inscoper::NBO::UnitsAngle_TypePtr & value, bool validate =true) Sets the value of the AngleOfIncidenceUnit attribute.
UnitsAngle_TypePtr	getAngleOfIncidenceUnit() const Returns the value of the AngleOfIncidenceUnit attribute.
void	resetAngleOfIncidenceUnit() Resets the AngleOfIncidenceUnit attribute to an unset state.
bool	hasAngleOfIncidenceUnit() const Checks whether the optional AngleOfIncidenceUnit attribute is present.
void	setSubstrateType(const std::string & value, bool validate =true) Sets the value of the SubstrateType attribute.
std::string	getSubstrateType() const Returns the value of the SubstrateType attribute.
void	resetSubstrateType() Resets the SubstrateType attribute to an unset state.
bool	hasSubstrateType() const Checks whether the SubstrateType attribute is present.
void	setSubstrateMaterial(const Inscoper::NBO::OpticalMaterialName_TypePtr & value, bool validate =true) Sets the value of the SubstrateMaterial attribute.
OpticalMaterialName_TypePtr	getSubstrateMaterial() const Returns the value of the SubstrateMaterial attribute.
void	resetSubstrateMaterial() Resets the SubstrateMaterial attribute to an unset state.
bool	hasSubstrateMaterial() const Checks whether the optional SubstrateMaterial attribute is present.
void	setGlassCode(const std::string & value, bool validate =true) Sets the value of the GlassCode attribute.
std::string	getGlassCode() const Returns the value of the GlassCode attribute.
void	resetGlassCode() Resets the GlassCode attribute to an unset state.
bool	hasGlassCode() const Checks whether the GlassCode attribute 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.
const std::set< std::string > &	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getAngleOfIncidenceUnitAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getSubstrateTypeAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
	~ManufacturerSpec_Type()
void	setManufacturer(const std::string & value, bool validate =true) Sets the value of the Manufacturer attribute.
std::string	getManufacturer() const Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
bool	hasManufacturer() const Checks whether the Manufacturer attribute is present.
void	setModel(const std::string & value, bool validate =true) Sets the value of the Model attribute.
std::string	getModel() const Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
bool	hasModel() const Checks whether the Model attribute is present.
void	setCatalogNumber(const std::string & value, bool validate =true) Sets the value of the CatalogNumber attribute.
std::string	getCatalogNumber() const Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
bool	hasCatalogNumber() const Checks whether the CatalogNumber attribute is present.
void	setLotNumber(const std::string & value, bool validate =true) Sets the value of the LotNumber attribute.
std::string	getLotNumber() const Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
bool	hasLotNumber() const Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true) Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr	getSpecsFile() const Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
bool	hasSpecsFile() const Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
const std::set< std::string > &	getManufacturerAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getModelAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::GenericDichroic;

Represents the XML element GenericDichroic.

A Dichroic Mirror (also often referred to as Dichroic Beamsplitter or simply as Dichroic) is a Mirror that spectrally separate light by transmitting and reflecting light as a function of wavelength. In the context of fluorescence microscopy, they are typically used to reflect the excitation light, but transmit the emitted fluorescence. Dichroic Mirrors can be categorized in different manners. However, the most important criteria for choosing a Dichoric Mirror are the Transmittance and the Reflectance Wavelength ranges. This element describes an additional Generic Dichroic positioned in the Ligth Path for one or more Channel available for this Instrument.

Public Functions Documentation¶

function GenericDichroic¶

function ~GenericDichroic¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function fromBase¶

static std::shared_ptr< GenericDichroic > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a GenericDichroic.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Updated on 2026-09-23 at 16:50:37 +0200