Inscoper::NBO::LightPath_Type¶

Represents the XML complex type LightPath. More...

#include <LightPath_Type.h>

Inherits from NBOBaseClass

Inherited by Inscoper::NBO::LightPath, Inscoper::NBO::TIRFLightPath

Public Classes¶

	Name
class	InlineLightPathMap Represents the XML element LightPathMap.

Public Types¶

	Name
typedef std::shared_ptr< InlineLightPathMap >	InlineLightPathMapPtr

Public Functions¶

	Name
	LightPath_Type()
	~LightPath_Type()
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::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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	setLightSourceSettings_List(const std::vector< Inscoper::NBO::LightSourceSettingsPtr > & value, bool validate =true) Sets the list of LightSourceSettings elements.
std::vector< Inscoper::NBO::LightSourceSettingsPtr >	getLightSourceSettings_List() const Returns the list of LightSourceSettings elements.
void	addToLightSourceSettings_List(const Inscoper::NBO::LightSourceSettingsPtr & value, bool validate =true) Adds a new LightSourceSettings element to this object.
void	clearLightSourceSettings_List() Clear the list of LightSourceSettings.
void	setLightSourceCouplingRef_List(const std::vector< Inscoper::NBO::LightSourceCouplingRefPtr > & value, bool validate =true) Sets the list of LightSourceCouplingRef elements.
std::vector< Inscoper::NBO::LightSourceCouplingRefPtr >	getLightSourceCouplingRef_List() const Returns the list of LightSourceCouplingRef elements.
void	addToLightSourceCouplingRef_List(const Inscoper::NBO::LightSourceCouplingRefPtr & value, bool validate =true) Adds a new LightSourceCouplingRef element to this object.
void	clearLightSourceCouplingRef_List() Clear the list of LightSourceCouplingRef.
void	setExcitationFilterRef_List(const std::vector< Inscoper::NBO::ExcitationFilterRefPtr > & value, bool validate =true) Sets the list of ExcitationFilterRef elements.
std::vector< Inscoper::NBO::ExcitationFilterRefPtr >	getExcitationFilterRef_List() const Returns the list of ExcitationFilterRef elements.
void	addToExcitationFilterRef_List(const Inscoper::NBO::ExcitationFilterRefPtr & value, bool validate =true) Adds a new ExcitationFilterRef element to this object.
void	clearExcitationFilterRef_List() Clear the list of ExcitationFilterRef.
void	setStandardDichroicRef_List(const std::vector< Inscoper::NBO::StandardDichroicRefPtr > & value, bool validate =true) Sets the list of StandardDichroicRef elements.
std::vector< Inscoper::NBO::StandardDichroicRefPtr >	getStandardDichroicRef_List() const Returns the list of StandardDichroicRef elements.
void	addToStandardDichroicRef_List(const Inscoper::NBO::StandardDichroicRefPtr & value, bool validate =true) Adds a new StandardDichroicRef element to this object.
void	clearStandardDichroicRef_List() Clear the list of StandardDichroicRef.
void	setEmissionFilterRef_List(const std::vector< Inscoper::NBO::EmissionFilterRefPtr > & value, bool validate =true) Sets the list of EmissionFilterRef elements.
std::vector< Inscoper::NBO::EmissionFilterRefPtr >	getEmissionFilterRef_List() const Returns the list of EmissionFilterRef elements.
void	addToEmissionFilterRef_List(const Inscoper::NBO::EmissionFilterRefPtr & value, bool validate =true) Adds a new EmissionFilterRef element to this object.
void	clearEmissionFilterRef_List() Clear the list of EmissionFilterRef.
void	setFilterSet_List(const std::vector< Inscoper::NBO::FilterSetPtr > & value, bool validate =true) Sets the list of FilterSet elements.
std::vector< Inscoper::NBO::FilterSetPtr >	getFilterSet_List() const Returns the list of FilterSet elements.
void	addToFilterSet_List(const Inscoper::NBO::FilterSetPtr & value, bool validate =true) Adds a new FilterSet element to this object.
void	clearFilterSet_List() Clear the list of FilterSet.
void	setGenericFilterRef_List(const std::vector< Inscoper::NBO::GenericFilterRefPtr > & value, bool validate =true) Sets the list of GenericFilterRef elements.
std::vector< Inscoper::NBO::GenericFilterRefPtr >	getGenericFilterRef_List() const Returns the list of GenericFilterRef elements.
void	addToGenericFilterRef_List(const Inscoper::NBO::GenericFilterRefPtr & value, bool validate =true) Adds a new GenericFilterRef element to this object.
void	clearGenericFilterRef_List() Clear the list of GenericFilterRef.
void	setLensSettings_List(const std::vector< Inscoper::NBO::LensSettingsPtr > & value, bool validate =true) Sets the list of LensSettings elements.
std::vector< Inscoper::NBO::LensSettingsPtr >	getLensSettings_List() const Returns the list of LensSettings elements.
void	addToLensSettings_List(const Inscoper::NBO::LensSettingsPtr & value, bool validate =true) Adds a new LensSettings element to this object.
void	clearLensSettings_List() Clear the list of LensSettings.
void	setMirroringDeviceSettings_List(const std::vector< Inscoper::NBO::MirroringDeviceSettingsPtr > & value, bool validate =true) Sets the list of MirroringDeviceSettings elements.
std::vector< Inscoper::NBO::MirroringDeviceSettingsPtr >	getMirroringDeviceSettings_List() const Returns the list of MirroringDeviceSettings elements.
void	addToMirroringDeviceSettings_List(const Inscoper::NBO::MirroringDeviceSettingsPtr & value, bool validate =true) Adds a new MirroringDeviceSettings element to this object.
void	clearMirroringDeviceSettings_List() Clear the list of MirroringDeviceSettings.
void	setApertureRef_List(const std::vector< Inscoper::NBO::ApertureRefPtr > & value, bool validate =true) Sets the list of ApertureRef elements.
std::vector< Inscoper::NBO::ApertureRefPtr >	getApertureRef_List() const Returns the list of ApertureRef elements.
void	addToApertureRef_List(const Inscoper::NBO::ApertureRefPtr & value, bool validate =true) Adds a new ApertureRef element to this object.
void	clearApertureRef_List() Clear the list of ApertureRef.
void	setOpticalAssemblyRef_List(const std::vector< Inscoper::NBO::OpticalAssemblyRefPtr > & value, bool validate =true) Sets the list of OpticalAssemblyRef elements.
std::vector< Inscoper::NBO::OpticalAssemblyRefPtr >	getOpticalAssemblyRef_List() const Returns the list of OpticalAssemblyRef elements.
void	addToOpticalAssemblyRef_List(const Inscoper::NBO::OpticalAssemblyRefPtr & value, bool validate =true) Adds a new OpticalAssemblyRef element to this object.
void	clearOpticalAssemblyRef_List() Clear the list of OpticalAssemblyRef.
void	setOpticalApertureSettingsGroup_List(const std::vector< Inscoper::NBO::OpticalApertureSettings_TypePtr > & value, bool validate =true) Sets the list of OpticalApertureSettingsGroup elements.
std::vector< Inscoper::NBO::OpticalApertureSettings_TypePtr >	getOpticalApertureSettingsGroup_List() const Returns the list of OpticalApertureSettingsGroup elements.
void	addToOpticalApertureSettingsGroup_List(const Inscoper::NBO::OpticalApertureSettings_TypePtr & value, bool validate =true) Adds a new OpticalApertureSettingsGroup element to this object.
void	clearOpticalApertureSettingsGroup_List() Clear the list of OpticalApertureSettingsGroup.
void	setPolarizationOpticsRef_List(const std::vector< Inscoper::NBO::PolarizationOpticsRef_TypePtr > & value, bool validate =true) Sets the list of PolarizationOpticsRef elements.
std::vector< Inscoper::NBO::PolarizationOpticsRef_TypePtr >	getPolarizationOpticsRef_List() const Returns the list of PolarizationOpticsRef elements.
void	addToPolarizationOpticsRef_List(const Inscoper::NBO::PolarizationOpticsRef_TypePtr & value, bool validate =true) Adds a new PolarizationOpticsRef element to this object.
void	clearPolarizationOpticsRef_List() Clear the list of PolarizationOpticsRef.
void	setPrismSettings_List(const std::vector< Inscoper::NBO::PrismSettingsPtr > & value, bool validate =true) Sets the list of PrismSettings elements.
std::vector< Inscoper::NBO::PrismSettingsPtr >	getPrismSettings_List() const Returns the list of PrismSettings elements.
void	addToPrismSettings_List(const Inscoper::NBO::PrismSettingsPtr & value, bool validate =true) Adds a new PrismSettings element to this object.
void	clearPrismSettings_List() Clear the list of PrismSettings.
void	setShutterSettings_List(const std::vector< Inscoper::NBO::ShutterSettingsPtr > & value, bool validate =true) Sets the list of ShutterSettings elements.
std::vector< Inscoper::NBO::ShutterSettingsPtr >	getShutterSettings_List() const Returns the list of ShutterSettings elements.
void	addToShutterSettings_List(const Inscoper::NBO::ShutterSettingsPtr & value, bool validate =true) Adds a new ShutterSettings element to this object.
void	clearShutterSettings_List() Clear the list of ShutterSettings.
void	setDetectorSettingsGroup_List(const std::vector< Inscoper::NBO::DetectorSettings_TypePtr > & value, bool validate =true) Sets the list of DetectorSettingsGroup elements.
std::vector< Inscoper::NBO::DetectorSettings_TypePtr >	getDetectorSettingsGroup_List() const Returns the list of DetectorSettingsGroup elements.
void	addToDetectorSettingsGroup_List(const Inscoper::NBO::DetectorSettings_TypePtr & value, bool validate =true) Adds a new DetectorSettingsGroup element to this object.
void	clearDetectorSettingsGroup_List() Clear the list of DetectorSettingsGroup.
void	setConfocalScannerSettings_List(const std::vector< Inscoper::NBO::ConfocalScannerSettingsPtr > & value, bool validate =true) Sets the list of ConfocalScannerSettings elements.
std::vector< Inscoper::NBO::ConfocalScannerSettingsPtr >	getConfocalScannerSettings_List() const Returns the list of ConfocalScannerSettings elements.
void	addToConfocalScannerSettings_List(const Inscoper::NBO::ConfocalScannerSettingsPtr & value, bool validate =true) Adds a new ConfocalScannerSettings element to this object.
void	clearConfocalScannerSettings_List() Clear the list of ConfocalScannerSettings.
void	setAcoustoOpticalDeviceSettingsGroup_List(const std::vector< Inscoper::NBO::AcoustoOpticalDeviceSettings_TypePtr > & value, bool validate =true) Sets the list of AcoustoOpticalDeviceSettingsGroup elements.
std::vector< Inscoper::NBO::AcoustoOpticalDeviceSettings_TypePtr >	getAcoustoOpticalDeviceSettingsGroup_List() const Returns the list of AcoustoOpticalDeviceSettingsGroup elements.
void	addToAcoustoOpticalDeviceSettingsGroup_List(const Inscoper::NBO::AcoustoOpticalDeviceSettings_TypePtr & value, bool validate =true) Adds a new AcoustoOpticalDeviceSettingsGroup element to this object.
void	clearAcoustoOpticalDeviceSettingsGroup_List() Clear the list of AcoustoOpticalDeviceSettingsGroup.
void	setElectroOpticalDeviceSettingsGroup_List(const std::vector< Inscoper::NBO::ElectroOpticalDeviceSettings_TypePtr > & value, bool validate =true) Sets the list of ElectroOpticalDeviceSettingsGroup elements.
std::vector< Inscoper::NBO::ElectroOpticalDeviceSettings_TypePtr >	getElectroOpticalDeviceSettingsGroup_List() const Returns the list of ElectroOpticalDeviceSettingsGroup elements.
void	addToElectroOpticalDeviceSettingsGroup_List(const Inscoper::NBO::ElectroOpticalDeviceSettings_TypePtr & value, bool validate =true) Adds a new ElectroOpticalDeviceSettingsGroup element to this object.
void	clearElectroOpticalDeviceSettingsGroup_List() Clear the list of ElectroOpticalDeviceSettingsGroup.
void	setTIRFSettings_List(const std::vector< Inscoper::NBO::TIRFSettingsPtr > & value, bool validate =true) Sets the list of TIRFSettings elements.
std::vector< Inscoper::NBO::TIRFSettingsPtr >	getTIRFSettings_List() const Returns the list of TIRFSettings elements.
void	addToTIRFSettings_List(const Inscoper::NBO::TIRFSettingsPtr & value, bool validate =true) Adds a new TIRFSettings element to this object.
void	clearTIRFSettings_List() Clear the list of TIRFSettings.
void	setLightPathMap(const Inscoper::NBO::LightPath_Type::InlineLightPathMapPtr & value, bool validate =true) Sets the value of the LightPathMap element.
Inscoper::NBO::LightPath_Type::InlineLightPathMapPtr	getLightPathMap() const Returns the value of the LightPathMap element.
void	resetLightPathMap() Resets the LightPathMap element to an unset state.
bool	hasLightPathMap() const Checks whether the optional LightPathMap element is present.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::AnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::AnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
std::shared_ptr< LightPath_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a LightPath_Type.

Detailed Description¶

class Inscoper::NBO::LightPath_Type;

Represents the XML complex type LightPath.

This empty element refers to a LightSourceCoupling component used in this light path.

Public Types Documentation¶

typedef InlineLightPathMapPtr¶

Public Functions Documentation¶

function LightPath_Type¶

function ~LightPath_Type¶

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 setID¶

void setID(
    const Inscoper::NBO::LSID_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 setLightSourceSettings_List¶

void setLightSourceSettings_List(
    const std::vector< Inscoper::NBO::LightSourceSettingsPtr > & value,
    bool validate =true
)

Sets the list of LightSourceSettings elements.

Parameters:

value The new list of LightSourceSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getLightSourceSettings_List¶

std::vector< Inscoper::NBO::LightSourceSettingsPtr > getLightSourceSettings_List() const

Returns the list of LightSourceSettings elements.

Return: The list of LightSourceSettings elements

No description available in the XSD standard.

function addToLightSourceSettings_List¶

void addToLightSourceSettings_List(
    const Inscoper::NBO::LightSourceSettingsPtr & value,
    bool validate =true
)

Adds a new LightSourceSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearLightSourceSettings_List¶

function setLightSourceCouplingRef_List¶

void setLightSourceCouplingRef_List(
    const std::vector< Inscoper::NBO::LightSourceCouplingRefPtr > & value,
    bool validate =true
)

Sets the list of LightSourceCouplingRef elements.

Parameters:

value The new list of LightSourceCouplingRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to a LightSourceCoupling component used in this light path.

function getLightSourceCouplingRef_List¶

std::vector< Inscoper::NBO::LightSourceCouplingRefPtr > getLightSourceCouplingRef_List() const

Returns the list of LightSourceCouplingRef elements.

Return: The list of LightSourceCouplingRef elements

This empty element refers to a LightSourceCoupling component used in this light path.

function addToLightSourceCouplingRef_List¶

void addToLightSourceCouplingRef_List(
    const Inscoper::NBO::LightSourceCouplingRefPtr & value,
    bool validate =true
)

Adds a new LightSourceCouplingRef element to this object.

Parameters:

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

This empty element refers to a LightSourceCoupling component used in this light path.

function clearLightSourceCouplingRef_List¶

function setExcitationFilterRef_List¶

void setExcitationFilterRef_List(
    const std::vector< Inscoper::NBO::ExcitationFilterRefPtr > & value,
    bool validate =true
)

Sets the list of ExcitationFilterRef elements.

Parameters:

value The new list of ExcitationFilterRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to an ExcitationFilter component used in this light path.

function getExcitationFilterRef_List¶

std::vector< Inscoper::NBO::ExcitationFilterRefPtr > getExcitationFilterRef_List() const

Returns the list of ExcitationFilterRef elements.

Return: The list of ExcitationFilterRef elements

This empty element refers to an ExcitationFilter component used in this light path.

function addToExcitationFilterRef_List¶

void addToExcitationFilterRef_List(
    const Inscoper::NBO::ExcitationFilterRefPtr & value,
    bool validate =true
)

Adds a new ExcitationFilterRef element to this object.

Parameters:

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

This empty element refers to an ExcitationFilter component used in this light path.

function clearExcitationFilterRef_List¶

function setStandardDichroicRef_List¶

void setStandardDichroicRef_List(
    const std::vector< Inscoper::NBO::StandardDichroicRefPtr > & value,
    bool validate =true
)

Sets the list of StandardDichroicRef elements.

Parameters:

value The new list of StandardDichroicRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to a StandardDichroic component used in this light path.

function getStandardDichroicRef_List¶

std::vector< Inscoper::NBO::StandardDichroicRefPtr > getStandardDichroicRef_List() const

Returns the list of StandardDichroicRef elements.

Return: The list of StandardDichroicRef elements

This empty element refers to a StandardDichroic component used in this light path.

function addToStandardDichroicRef_List¶

void addToStandardDichroicRef_List(
    const Inscoper::NBO::StandardDichroicRefPtr & value,
    bool validate =true
)

Adds a new StandardDichroicRef element to this object.

Parameters:

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

This empty element refers to a StandardDichroic component used in this light path.

function clearStandardDichroicRef_List¶

function setEmissionFilterRef_List¶

void setEmissionFilterRef_List(
    const std::vector< Inscoper::NBO::EmissionFilterRefPtr > & value,
    bool validate =true
)

Sets the list of EmissionFilterRef elements.

Parameters:

value The new list of EmissionFilterRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to an EmissionFilter component used in this light path.

function getEmissionFilterRef_List¶

std::vector< Inscoper::NBO::EmissionFilterRefPtr > getEmissionFilterRef_List() const

Returns the list of EmissionFilterRef elements.

Return: The list of EmissionFilterRef elements

This empty element refers to an EmissionFilter component used in this light path.

function addToEmissionFilterRef_List¶

void addToEmissionFilterRef_List(
    const Inscoper::NBO::EmissionFilterRefPtr & value,
    bool validate =true
)

Adds a new EmissionFilterRef element to this object.

Parameters:

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

This empty element refers to an EmissionFilter component used in this light path.

function clearEmissionFilterRef_List¶

function setFilterSet_List¶

void setFilterSet_List(
    const std::vector< Inscoper::NBO::FilterSetPtr > & value,
    bool validate =true
)

Sets the list of FilterSet elements.

Parameters:

value The new list of FilterSet elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getFilterSet_List¶

function addToFilterSet_List¶

void addToFilterSet_List(
    const Inscoper::NBO::FilterSetPtr & value,
    bool validate =true
)

Adds a new FilterSet element to this object.

Parameters:

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

No description available in the XSD standard.

function clearFilterSet_List¶

function setGenericFilterRef_List¶

void setGenericFilterRef_List(
    const std::vector< Inscoper::NBO::GenericFilterRefPtr > & value,
    bool validate =true
)

Sets the list of GenericFilterRef elements.

Parameters:

value The new list of GenericFilterRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to an additional Generic Filter component placed in this Light Path.

function getGenericFilterRef_List¶

std::vector< Inscoper::NBO::GenericFilterRefPtr > getGenericFilterRef_List() const

Returns the list of GenericFilterRef elements.

Return: The list of GenericFilterRef elements

This empty element refers to an additional Generic Filter component placed in this Light Path.

function addToGenericFilterRef_List¶

void addToGenericFilterRef_List(
    const Inscoper::NBO::GenericFilterRefPtr & value,
    bool validate =true
)

Adds a new GenericFilterRef element to this object.

Parameters:

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

This empty element refers to an additional Generic Filter component placed in this Light Path.

function clearGenericFilterRef_List¶

function setLensSettings_List¶

void setLensSettings_List(
    const std::vector< Inscoper::NBO::LensSettingsPtr > & value,
    bool validate =true
)

Sets the list of LensSettings elements.

Parameters:

value The new list of LensSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getLensSettings_List¶

std::vector< Inscoper::NBO::LensSettingsPtr > getLensSettings_List() const

Returns the list of LensSettings elements.

Return: The list of LensSettings elements

No description available in the XSD standard.

function addToLensSettings_List¶

void addToLensSettings_List(
    const Inscoper::NBO::LensSettingsPtr & value,
    bool validate =true
)

Adds a new LensSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearLensSettings_List¶

function setMirroringDeviceSettings_List¶

void setMirroringDeviceSettings_List(
    const std::vector< Inscoper::NBO::MirroringDeviceSettingsPtr > & value,
    bool validate =true
)

Sets the list of MirroringDeviceSettings elements.

Parameters:

value The new list of MirroringDeviceSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getMirroringDeviceSettings_List¶

std::vector< Inscoper::NBO::MirroringDeviceSettingsPtr > getMirroringDeviceSettings_List() const

Returns the list of MirroringDeviceSettings elements.

Return: The list of MirroringDeviceSettings elements

No description available in the XSD standard.

function addToMirroringDeviceSettings_List¶

void addToMirroringDeviceSettings_List(
    const Inscoper::NBO::MirroringDeviceSettingsPtr & value,
    bool validate =true
)

Adds a new MirroringDeviceSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearMirroringDeviceSettings_List¶

function setApertureRef_List¶

void setApertureRef_List(
    const std::vector< Inscoper::NBO::ApertureRefPtr > & value,
    bool validate =true
)

Sets the list of ApertureRef elements.

Parameters:

value The new list of ApertureRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getApertureRef_List¶

std::vector< Inscoper::NBO::ApertureRefPtr > getApertureRef_List() const

Returns the list of ApertureRef elements.

Return: The list of ApertureRef elements

No description available in the XSD standard.

function addToApertureRef_List¶

void addToApertureRef_List(
    const Inscoper::NBO::ApertureRefPtr & value,
    bool validate =true
)

Adds a new ApertureRef element to this object.

Parameters:

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

No description available in the XSD standard.

function clearApertureRef_List¶

function setOpticalAssemblyRef_List¶

void setOpticalAssemblyRef_List(
    const std::vector< Inscoper::NBO::OpticalAssemblyRefPtr > & value,
    bool validate =true
)

Sets the list of OpticalAssemblyRef elements.

Parameters:

value The new list of OpticalAssemblyRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getOpticalAssemblyRef_List¶

std::vector< Inscoper::NBO::OpticalAssemblyRefPtr > getOpticalAssemblyRef_List() const

Returns the list of OpticalAssemblyRef elements.

Return: The list of OpticalAssemblyRef elements

No description available in the XSD standard.

function addToOpticalAssemblyRef_List¶

void addToOpticalAssemblyRef_List(
    const Inscoper::NBO::OpticalAssemblyRefPtr & value,
    bool validate =true
)

Adds a new OpticalAssemblyRef element to this object.

Parameters:

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

No description available in the XSD standard.

function clearOpticalAssemblyRef_List¶

function setOpticalApertureSettingsGroup_List¶

void setOpticalApertureSettingsGroup_List(
    const std::vector< Inscoper::NBO::OpticalApertureSettings_TypePtr > & value,
    bool validate =true
)

Sets the list of OpticalApertureSettingsGroup elements.

Parameters:

value The new list of OpticalApertureSettingsGroup elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getOpticalApertureSettingsGroup_List¶

std::vector< Inscoper::NBO::OpticalApertureSettings_TypePtr > getOpticalApertureSettingsGroup_List() const

Returns the list of OpticalApertureSettingsGroup elements.

Return: The list of OpticalApertureSettingsGroup elements

No description available in the XSD standard.

function addToOpticalApertureSettingsGroup_List¶

void addToOpticalApertureSettingsGroup_List(
    const Inscoper::NBO::OpticalApertureSettings_TypePtr & value,
    bool validate =true
)

Adds a new OpticalApertureSettingsGroup element to this object.

Parameters:

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

No description available in the XSD standard.

function clearOpticalApertureSettingsGroup_List¶

function setPolarizationOpticsRef_List¶

void setPolarizationOpticsRef_List(
    const std::vector< Inscoper::NBO::PolarizationOpticsRef_TypePtr > & value,
    bool validate =true
)

Sets the list of PolarizationOpticsRef elements.

Parameters:

value The new list of PolarizationOpticsRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to a PolarizationOptics component placed in this light path.

function getPolarizationOpticsRef_List¶

std::vector< Inscoper::NBO::PolarizationOpticsRef_TypePtr > getPolarizationOpticsRef_List() const

Returns the list of PolarizationOpticsRef elements.

Return: The list of PolarizationOpticsRef elements

This empty element refers to a PolarizationOptics component placed in this light path.

function addToPolarizationOpticsRef_List¶

void addToPolarizationOpticsRef_List(
    const Inscoper::NBO::PolarizationOpticsRef_TypePtr & value,
    bool validate =true
)

Adds a new PolarizationOpticsRef element to this object.

Parameters:

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

This empty element refers to a PolarizationOptics component placed in this light path.

function clearPolarizationOpticsRef_List¶

function setPrismSettings_List¶

void setPrismSettings_List(
    const std::vector< Inscoper::NBO::PrismSettingsPtr > & value,
    bool validate =true
)

Sets the list of PrismSettings elements.

Parameters:

value The new list of PrismSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getPrismSettings_List¶

std::vector< Inscoper::NBO::PrismSettingsPtr > getPrismSettings_List() const

Returns the list of PrismSettings elements.

Return: The list of PrismSettings elements

No description available in the XSD standard.

function addToPrismSettings_List¶

void addToPrismSettings_List(
    const Inscoper::NBO::PrismSettingsPtr & value,
    bool validate =true
)

Adds a new PrismSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearPrismSettings_List¶

function setShutterSettings_List¶

void setShutterSettings_List(
    const std::vector< Inscoper::NBO::ShutterSettingsPtr > & value,
    bool validate =true
)

Sets the list of ShutterSettings elements.

Parameters:

value The new list of ShutterSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getShutterSettings_List¶

std::vector< Inscoper::NBO::ShutterSettingsPtr > getShutterSettings_List() const

Returns the list of ShutterSettings elements.

Return: The list of ShutterSettings elements

No description available in the XSD standard.

function addToShutterSettings_List¶

void addToShutterSettings_List(
    const Inscoper::NBO::ShutterSettingsPtr & value,
    bool validate =true
)

Adds a new ShutterSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearShutterSettings_List¶

function setDetectorSettingsGroup_List¶

void setDetectorSettingsGroup_List(
    const std::vector< Inscoper::NBO::DetectorSettings_TypePtr > & value,
    bool validate =true
)

Sets the list of DetectorSettingsGroup elements.

Parameters:

value The new list of DetectorSettingsGroup elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getDetectorSettingsGroup_List¶

std::vector< Inscoper::NBO::DetectorSettings_TypePtr > getDetectorSettingsGroup_List() const

Returns the list of DetectorSettingsGroup elements.

Return: The list of DetectorSettingsGroup elements

No description available in the XSD standard.

function addToDetectorSettingsGroup_List¶

void addToDetectorSettingsGroup_List(
    const Inscoper::NBO::DetectorSettings_TypePtr & value,
    bool validate =true
)

Adds a new DetectorSettingsGroup element to this object.

Parameters:

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

No description available in the XSD standard.

function clearDetectorSettingsGroup_List¶

function setConfocalScannerSettings_List¶

void setConfocalScannerSettings_List(
    const std::vector< Inscoper::NBO::ConfocalScannerSettingsPtr > & value,
    bool validate =true
)

Sets the list of ConfocalScannerSettings elements.

Parameters:

value The new list of ConfocalScannerSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getConfocalScannerSettings_List¶

std::vector< Inscoper::NBO::ConfocalScannerSettingsPtr > getConfocalScannerSettings_List() const

Returns the list of ConfocalScannerSettings elements.

Return: The list of ConfocalScannerSettings elements

No description available in the XSD standard.

function addToConfocalScannerSettings_List¶

void addToConfocalScannerSettings_List(
    const Inscoper::NBO::ConfocalScannerSettingsPtr & value,
    bool validate =true
)

Adds a new ConfocalScannerSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearConfocalScannerSettings_List¶

function setAcoustoOpticalDeviceSettingsGroup_List¶

void setAcoustoOpticalDeviceSettingsGroup_List(
    const std::vector< Inscoper::NBO::AcoustoOpticalDeviceSettings_TypePtr > & value,
    bool validate =true
)

Sets the list of AcoustoOpticalDeviceSettingsGroup elements.

Parameters:

value The new list of AcoustoOpticalDeviceSettingsGroup elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAcoustoOpticalDeviceSettingsGroup_List¶

std::vector< Inscoper::NBO::AcoustoOpticalDeviceSettings_TypePtr > getAcoustoOpticalDeviceSettingsGroup_List() const

Returns the list of AcoustoOpticalDeviceSettingsGroup elements.

Return: The list of AcoustoOpticalDeviceSettingsGroup elements

No description available in the XSD standard.

function addToAcoustoOpticalDeviceSettingsGroup_List¶

void addToAcoustoOpticalDeviceSettingsGroup_List(
    const Inscoper::NBO::AcoustoOpticalDeviceSettings_TypePtr & value,
    bool validate =true
)

Adds a new AcoustoOpticalDeviceSettingsGroup element to this object.

Parameters:

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

No description available in the XSD standard.

function clearAcoustoOpticalDeviceSettingsGroup_List¶

function setElectroOpticalDeviceSettingsGroup_List¶

void setElectroOpticalDeviceSettingsGroup_List(
    const std::vector< Inscoper::NBO::ElectroOpticalDeviceSettings_TypePtr > & value,
    bool validate =true
)

Sets the list of ElectroOpticalDeviceSettingsGroup elements.

Parameters:

value The new list of ElectroOpticalDeviceSettingsGroup elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getElectroOpticalDeviceSettingsGroup_List¶

std::vector< Inscoper::NBO::ElectroOpticalDeviceSettings_TypePtr > getElectroOpticalDeviceSettingsGroup_List() const

Returns the list of ElectroOpticalDeviceSettingsGroup elements.

Return: The list of ElectroOpticalDeviceSettingsGroup elements

No description available in the XSD standard.

function addToElectroOpticalDeviceSettingsGroup_List¶

void addToElectroOpticalDeviceSettingsGroup_List(
    const Inscoper::NBO::ElectroOpticalDeviceSettings_TypePtr & value,
    bool validate =true
)

Adds a new ElectroOpticalDeviceSettingsGroup element to this object.

Parameters:

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

No description available in the XSD standard.

function clearElectroOpticalDeviceSettingsGroup_List¶

function setTIRFSettings_List¶

void setTIRFSettings_List(
    const std::vector< Inscoper::NBO::TIRFSettingsPtr > & value,
    bool validate =true
)

Sets the list of TIRFSettings elements.

Parameters:

value The new list of TIRFSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getTIRFSettings_List¶

std::vector< Inscoper::NBO::TIRFSettingsPtr > getTIRFSettings_List() const

Returns the list of TIRFSettings elements.

Return: The list of TIRFSettings elements

No description available in the XSD standard.

function addToTIRFSettings_List¶

void addToTIRFSettings_List(
    const Inscoper::NBO::TIRFSettingsPtr & value,
    bool validate =true
)

Adds a new TIRFSettings element to this object.

Parameters:

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

No description available in the XSD standard.

function clearTIRFSettings_List¶

function setLightPathMap¶

void setLightPathMap(
    const Inscoper::NBO::LightPath_Type::InlineLightPathMapPtr & value,
    bool validate =true
)

Sets the value of the LightPathMap element.

Parameters:

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

This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.

function getLightPathMap¶

Inscoper::NBO::LightPath_Type::InlineLightPathMapPtr getLightPathMap() const

Returns the value of the LightPathMap element.

Return: The value of the element

This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.

function resetLightPathMap¶

void resetLightPathMap()

Resets the LightPathMap element to an unset state.

This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.

function hasLightPathMap¶

bool hasLightPathMap() const

Checks whether the optional LightPathMap element is present.

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

This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.

function setAnnotationRef_List¶

void setAnnotationRef_List(
    const std::vector< Inscoper::NBO::AnnotationRefPtr > & value,
    bool validate =true
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAnnotationRef_List¶

std::vector< Inscoper::NBO::AnnotationRefPtr > getAnnotationRef_List() const

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

void addToAnnotationRef_List(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Adds a new AnnotationRef element to this object.

Parameters:

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

No description available in the XSD standard.

function clearAnnotationRef_List¶

function fromBase¶

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

Cast a NBOBaseClass to a LightPath_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