Inscoper::NBO::LightSourceCoupling_Type¶

Represents the XML complex type LightSourceCoupling. More...

#include <LightSourceCoupling_Type.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::FreeBeam, Inscoper::NBO::LightGuide

Public Classes¶

	Name
class	InlineAnnotationRef Represents the XML element AnnotationRef.

Public Types¶

	Name
typedef std::shared_ptr< InlineAnnotationRef >	InlineAnnotationRefPtr

Public Functions¶

	Name
	LightSourceCoupling_Type()
	~LightSourceCoupling_Type()
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.
void	setID(const Inscoper::NBO::LightSourceCouplingID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LightSourceCouplingID_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	setAttenuation(const float & value, bool validate =true) Sets the value of the Attenuation attribute.
float	getAttenuation() const Returns the value of the Attenuation attribute.
void	resetAttenuation() Resets the Attenuation attribute to an unset state.
bool	hasAttenuation() const Checks whether the Attenuation attribute is present.
void	setTransmittance(const float & value, bool validate =true) Sets the value of the Transmittance attribute.
float	getTransmittance() const Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
bool	hasTransmittance() const Checks whether the Transmittance attribute is present.
void	setCouplingLensRef(const Inscoper::NBO::LensRef_TypePtr & value, bool validate =true) Sets the value of the CouplingLensRef element.
Inscoper::NBO::LensRef_TypePtr	getCouplingLensRef() const Returns the value of the CouplingLensRef element.
void	resetCouplingLensRef() Resets the CouplingLensRef element to an unset state.
bool	hasCouplingLensRef() const Checks whether the optional CouplingLensRef element is present.
void	setAnnotationRef(const Inscoper::NBO::LightSourceCoupling_Type::InlineAnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::LightSourceCoupling_Type::InlineAnnotationRefPtr	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< LightSourceCoupling_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a LightSourceCoupling_Type.

Additional inherited members¶

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::LightSourceCoupling_Type;

Represents the XML complex type LightSourceCoupling.

This element describes the device(s)/method(s) used to couple an available Light Source(s) with this Microscope Stand to transfer light to the specimen. A typical light Microscope has a Light Coupling device for each available Light Source.

Public Types Documentation¶

typedef InlineAnnotationRefPtr¶

Public Functions Documentation¶

function LightSourceCoupling_Type¶

function ~LightSourceCoupling_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::FreeBeam::getTypeName, Inscoper::NBO::LightGuide::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 setID¶

void setID(
    const Inscoper::NBO::LightSourceCouplingID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & value,
    bool validate =true
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A User-defined Name for this component.

function getName¶

function resetName¶

function hasName¶

function setAttenuation¶

void setAttenuation(
    const float & value,
    bool validate =true
)

Sets the value of the Attenuation attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

function getAttenuation¶

float getAttenuation() const

Returns the value of the Attenuation attribute.

Return: The value of the attribute

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

function resetAttenuation¶

void resetAttenuation()

Resets the Attenuation attribute to an unset state.

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

function hasAttenuation¶

bool hasAttenuation() const

Checks whether the Attenuation attribute is present.

Return: true if the attribute has been set, false otherwise

This field reports a measure of the capacity of this Light Source Coupling device to attenuate the Illumination Power of the light passing through measured at the Peak Wavelength and expressed in dB/km.

function setTransmittance¶

void setTransmittance(
    const float & value,
    bool validate =true
)

Sets the value of the Transmittance attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The maximum amount of light this Light Source Coupling device is capable of transmitting at the Peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function getTransmittance¶

float getTransmittance() const

Returns the value of the Transmittance attribute.

Return: The value of the attribute

The maximum amount of light this Light Source Coupling device is capable of transmitting at the Peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function resetTransmittance¶

void resetTransmittance()

Resets the Transmittance attribute to an unset state.

The maximum amount of light this Light Source Coupling device is capable of transmitting at the Peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function hasTransmittance¶

bool hasTransmittance() const

Checks whether the Transmittance attribute is present.

Return: true if the attribute has been set, false otherwise

The maximum amount of light this Light Source Coupling device is capable of transmitting at the Peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function setCouplingLensRef¶

void setCouplingLensRef(
    const Inscoper::NBO::LensRef_TypePtr & value,
    bool validate =true
)

Sets the value of the CouplingLensRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

function getCouplingLensRef¶

Inscoper::NBO::LensRef_TypePtr getCouplingLensRef() const

Returns the value of the CouplingLensRef element.

Return: The value of the element

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

function resetCouplingLensRef¶

void resetCouplingLensRef()

Resets the CouplingLensRef element to an unset state.

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

function hasCouplingLensRef¶

bool hasCouplingLensRef() const

Checks whether the optional CouplingLensRef element is present.

Return: true if the optional attribute has been set, false otherwise

This is a reference to a Lens positioned at the connection between this Light Source coupling element and the Microscope Stand.

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::LightSourceCoupling_Type::InlineAnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

Inscoper::NBO::LightSourceCoupling_Type::InlineAnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

Return: true if the optional attribute has been set, false otherwise

This is a simple multi-line comment or annotation describing this component.

function fromBase¶

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

Cast a NBOBaseClass to a LightSourceCoupling_Type.

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:38 +0200