com.inscoper.nbo.LightPath

Represents the XML element LightPath. More...

Inherits from com.inscoper.nbo.LightPath_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	LightPath()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
LightPath	__internal_create(long cPtr, boolean own)
LightPath	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions

	Name
	LightPath(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(LightPath obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.LightPath_Type

	Name
	LightPath_Type()
void	setID(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setLightSourceSettings_List(LightSourceSettingsVector value, boolean validate) Sets the list of LightSourceSettings elements.
void	setLightSourceSettings_List(LightSourceSettingsVector value) Sets the list of LightSourceSettings elements.
LightSourceSettingsVector	getLightSourceSettings_List() Returns the list of LightSourceSettings elements.
void	addToLightSourceSettings_List(LightSourceSettings value, boolean validate) Adds a new LightSourceSettings element to this object.
void	addToLightSourceSettings_List(LightSourceSettings value) Adds a new LightSourceSettings element to this object.
void	clearLightSourceSettings_List() Clear the list of LightSourceSettings.
void	setLightSourceCouplingRef_List(LightSourceCouplingRefVector value, boolean validate) Sets the list of LightSourceCouplingRef elements.
void	setLightSourceCouplingRef_List(LightSourceCouplingRefVector value) Sets the list of LightSourceCouplingRef elements.
LightSourceCouplingRefVector	getLightSourceCouplingRef_List() Returns the list of LightSourceCouplingRef elements.
void	addToLightSourceCouplingRef_List(LightSourceCouplingRef value, boolean validate) Adds a new LightSourceCouplingRef element to this object.
void	addToLightSourceCouplingRef_List(LightSourceCouplingRef value) Adds a new LightSourceCouplingRef element to this object.
void	clearLightSourceCouplingRef_List() Clear the list of LightSourceCouplingRef.
void	setExcitationFilterRef_List(ExcitationFilterRefVector value, boolean validate) Sets the list of ExcitationFilterRef elements.
void	setExcitationFilterRef_List(ExcitationFilterRefVector value) Sets the list of ExcitationFilterRef elements.
ExcitationFilterRefVector	getExcitationFilterRef_List() Returns the list of ExcitationFilterRef elements.
void	addToExcitationFilterRef_List(ExcitationFilterRef value, boolean validate) Adds a new ExcitationFilterRef element to this object.
void	addToExcitationFilterRef_List(ExcitationFilterRef value) Adds a new ExcitationFilterRef element to this object.
void	clearExcitationFilterRef_List() Clear the list of ExcitationFilterRef.
void	setStandardDichroicRef_List(StandardDichroicRefVector value, boolean validate) Sets the list of StandardDichroicRef elements.
void	setStandardDichroicRef_List(StandardDichroicRefVector value) Sets the list of StandardDichroicRef elements.
StandardDichroicRefVector	getStandardDichroicRef_List() Returns the list of StandardDichroicRef elements.
void	addToStandardDichroicRef_List(StandardDichroicRef value, boolean validate) Adds a new StandardDichroicRef element to this object.
void	addToStandardDichroicRef_List(StandardDichroicRef value) Adds a new StandardDichroicRef element to this object.
void	clearStandardDichroicRef_List() Clear the list of StandardDichroicRef.
void	setEmissionFilterRef_List(EmissionFilterRefVector value, boolean validate) Sets the list of EmissionFilterRef elements.
void	setEmissionFilterRef_List(EmissionFilterRefVector value) Sets the list of EmissionFilterRef elements.
EmissionFilterRefVector	getEmissionFilterRef_List() Returns the list of EmissionFilterRef elements.
void	addToEmissionFilterRef_List(EmissionFilterRef value, boolean validate) Adds a new EmissionFilterRef element to this object.
void	addToEmissionFilterRef_List(EmissionFilterRef value) Adds a new EmissionFilterRef element to this object.
void	clearEmissionFilterRef_List() Clear the list of EmissionFilterRef.
void	setFilterSet_List(FilterSetVector value, boolean validate) Sets the list of FilterSet elements.
void	setFilterSet_List(FilterSetVector value) Sets the list of FilterSet elements.
FilterSetVector	getFilterSet_List() Returns the list of FilterSet elements.
void	addToFilterSet_List(FilterSet value, boolean validate) Adds a new FilterSet element to this object.
void	addToFilterSet_List(FilterSet value) Adds a new FilterSet element to this object.
void	clearFilterSet_List() Clear the list of FilterSet.
void	setGenericFilterRef_List(GenericFilterRefVector value, boolean validate) Sets the list of GenericFilterRef elements.
void	setGenericFilterRef_List(GenericFilterRefVector value) Sets the list of GenericFilterRef elements.
GenericFilterRefVector	getGenericFilterRef_List() Returns the list of GenericFilterRef elements.
void	addToGenericFilterRef_List(GenericFilterRef value, boolean validate) Adds a new GenericFilterRef element to this object.
void	addToGenericFilterRef_List(GenericFilterRef value) Adds a new GenericFilterRef element to this object.
void	clearGenericFilterRef_List() Clear the list of GenericFilterRef.
void	setLensSettings_List(LensSettingsVector value, boolean validate) Sets the list of LensSettings elements.
void	setLensSettings_List(LensSettingsVector value) Sets the list of LensSettings elements.
LensSettingsVector	getLensSettings_List() Returns the list of LensSettings elements.
void	addToLensSettings_List(LensSettings value, boolean validate) Adds a new LensSettings element to this object.
void	addToLensSettings_List(LensSettings value) Adds a new LensSettings element to this object.
void	clearLensSettings_List() Clear the list of LensSettings.
void	setMirroringDeviceSettings_List(MirroringDeviceSettingsVector value, boolean validate) Sets the list of MirroringDeviceSettings elements.
void	setMirroringDeviceSettings_List(MirroringDeviceSettingsVector value) Sets the list of MirroringDeviceSettings elements.
MirroringDeviceSettingsVector	getMirroringDeviceSettings_List() Returns the list of MirroringDeviceSettings elements.
void	addToMirroringDeviceSettings_List(MirroringDeviceSettings value, boolean validate) Adds a new MirroringDeviceSettings element to this object.
void	addToMirroringDeviceSettings_List(MirroringDeviceSettings value) Adds a new MirroringDeviceSettings element to this object.
void	clearMirroringDeviceSettings_List() Clear the list of MirroringDeviceSettings.
void	setApertureRef_List(ApertureRefVector value, boolean validate) Sets the list of ApertureRef elements.
void	setApertureRef_List(ApertureRefVector value) Sets the list of ApertureRef elements.
ApertureRefVector	getApertureRef_List() Returns the list of ApertureRef elements.
void	addToApertureRef_List(ApertureRef value, boolean validate) Adds a new ApertureRef element to this object.
void	addToApertureRef_List(ApertureRef value) Adds a new ApertureRef element to this object.
void	clearApertureRef_List() Clear the list of ApertureRef.
void	setOpticalAssemblyRef_List(OpticalAssemblyRefVector value, boolean validate) Sets the list of OpticalAssemblyRef elements.
void	setOpticalAssemblyRef_List(OpticalAssemblyRefVector value) Sets the list of OpticalAssemblyRef elements.
OpticalAssemblyRefVector	getOpticalAssemblyRef_List() Returns the list of OpticalAssemblyRef elements.
void	addToOpticalAssemblyRef_List(OpticalAssemblyRef value, boolean validate) Adds a new OpticalAssemblyRef element to this object.
void	addToOpticalAssemblyRef_List(OpticalAssemblyRef value) Adds a new OpticalAssemblyRef element to this object.
void	clearOpticalAssemblyRef_List() Clear the list of OpticalAssemblyRef.
void	setOpticalApertureSettingsGroup_List(OpticalApertureSettings_TypeVector value, boolean validate) Sets the list of OpticalApertureSettingsGroup elements.
void	setOpticalApertureSettingsGroup_List(OpticalApertureSettings_TypeVector value) Sets the list of OpticalApertureSettingsGroup elements.
OpticalApertureSettings_TypeVector	getOpticalApertureSettingsGroup_List() Returns the list of OpticalApertureSettingsGroup elements.
void	addToOpticalApertureSettingsGroup_List(OpticalApertureSettings_Type value, boolean validate) Adds a new OpticalApertureSettingsGroup element to this object.
void	addToOpticalApertureSettingsGroup_List(OpticalApertureSettings_Type value) Adds a new OpticalApertureSettingsGroup element to this object.
void	clearOpticalApertureSettingsGroup_List() Clear the list of OpticalApertureSettingsGroup.
void	setPolarizationOpticsRef_List(PolarizationOpticsRef_TypeVector value, boolean validate) Sets the list of PolarizationOpticsRef elements.
void	setPolarizationOpticsRef_List(PolarizationOpticsRef_TypeVector value) Sets the list of PolarizationOpticsRef elements.
PolarizationOpticsRef_TypeVector	getPolarizationOpticsRef_List() Returns the list of PolarizationOpticsRef elements.
void	addToPolarizationOpticsRef_List(PolarizationOpticsRef_Type value, boolean validate) Adds a new PolarizationOpticsRef element to this object.
void	addToPolarizationOpticsRef_List(PolarizationOpticsRef_Type value) Adds a new PolarizationOpticsRef element to this object.
void	clearPolarizationOpticsRef_List() Clear the list of PolarizationOpticsRef.
void	setPrismSettings_List(PrismSettingsVector value, boolean validate) Sets the list of PrismSettings elements.
void	setPrismSettings_List(PrismSettingsVector value) Sets the list of PrismSettings elements.
PrismSettingsVector	getPrismSettings_List() Returns the list of PrismSettings elements.
void	addToPrismSettings_List(PrismSettings value, boolean validate) Adds a new PrismSettings element to this object.
void	addToPrismSettings_List(PrismSettings value) Adds a new PrismSettings element to this object.
void	clearPrismSettings_List() Clear the list of PrismSettings.
void	setShutterSettings_List(ShutterSettingsVector value, boolean validate) Sets the list of ShutterSettings elements.
void	setShutterSettings_List(ShutterSettingsVector value) Sets the list of ShutterSettings elements.
ShutterSettingsVector	getShutterSettings_List() Returns the list of ShutterSettings elements.
void	addToShutterSettings_List(ShutterSettings value, boolean validate) Adds a new ShutterSettings element to this object.
void	addToShutterSettings_List(ShutterSettings value) Adds a new ShutterSettings element to this object.
void	clearShutterSettings_List() Clear the list of ShutterSettings.
void	setDetectorSettingsGroup_List(DetectorSettings_TypeVector value, boolean validate) Sets the list of DetectorSettingsGroup elements.
void	setDetectorSettingsGroup_List(DetectorSettings_TypeVector value) Sets the list of DetectorSettingsGroup elements.
DetectorSettings_TypeVector	getDetectorSettingsGroup_List() Returns the list of DetectorSettingsGroup elements.
void	addToDetectorSettingsGroup_List(DetectorSettings_Type value, boolean validate) Adds a new DetectorSettingsGroup element to this object.
void	addToDetectorSettingsGroup_List(DetectorSettings_Type value) Adds a new DetectorSettingsGroup element to this object.
void	clearDetectorSettingsGroup_List() Clear the list of DetectorSettingsGroup.
void	setConfocalScannerSettings_List(ConfocalScannerSettingsVector value, boolean validate) Sets the list of ConfocalScannerSettings elements.
void	setConfocalScannerSettings_List(ConfocalScannerSettingsVector value) Sets the list of ConfocalScannerSettings elements.
ConfocalScannerSettingsVector	getConfocalScannerSettings_List() Returns the list of ConfocalScannerSettings elements.
void	addToConfocalScannerSettings_List(ConfocalScannerSettings value, boolean validate) Adds a new ConfocalScannerSettings element to this object.
void	addToConfocalScannerSettings_List(ConfocalScannerSettings value) Adds a new ConfocalScannerSettings element to this object.
void	clearConfocalScannerSettings_List() Clear the list of ConfocalScannerSettings.
void	setAcoustoOpticalDeviceSettingsGroup_List(AcoustoOpticalDeviceSettings_TypeVector value, boolean validate) Sets the list of AcoustoOpticalDeviceSettingsGroup elements.
void	setAcoustoOpticalDeviceSettingsGroup_List(AcoustoOpticalDeviceSettings_TypeVector value) Sets the list of AcoustoOpticalDeviceSettingsGroup elements.
AcoustoOpticalDeviceSettings_TypeVector	getAcoustoOpticalDeviceSettingsGroup_List() Returns the list of AcoustoOpticalDeviceSettingsGroup elements.
void	addToAcoustoOpticalDeviceSettingsGroup_List(AcoustoOpticalDeviceSettings_Type value, boolean validate) Adds a new AcoustoOpticalDeviceSettingsGroup element to this object.
void	addToAcoustoOpticalDeviceSettingsGroup_List(AcoustoOpticalDeviceSettings_Type value) Adds a new AcoustoOpticalDeviceSettingsGroup element to this object.
void	clearAcoustoOpticalDeviceSettingsGroup_List() Clear the list of AcoustoOpticalDeviceSettingsGroup.
void	setElectroOpticalDeviceSettingsGroup_List(ElectroOpticalDeviceSettings_TypeVector value, boolean validate) Sets the list of ElectroOpticalDeviceSettingsGroup elements.
void	setElectroOpticalDeviceSettingsGroup_List(ElectroOpticalDeviceSettings_TypeVector value) Sets the list of ElectroOpticalDeviceSettingsGroup elements.
ElectroOpticalDeviceSettings_TypeVector	getElectroOpticalDeviceSettingsGroup_List() Returns the list of ElectroOpticalDeviceSettingsGroup elements.
void	addToElectroOpticalDeviceSettingsGroup_List(ElectroOpticalDeviceSettings_Type value, boolean validate) Adds a new ElectroOpticalDeviceSettingsGroup element to this object.
void	addToElectroOpticalDeviceSettingsGroup_List(ElectroOpticalDeviceSettings_Type value) Adds a new ElectroOpticalDeviceSettingsGroup element to this object.
void	clearElectroOpticalDeviceSettingsGroup_List() Clear the list of ElectroOpticalDeviceSettingsGroup.
void	setTIRFSettings_List(TIRFSettingsVector value, boolean validate) Sets the list of TIRFSettings elements.
void	setTIRFSettings_List(TIRFSettingsVector value) Sets the list of TIRFSettings elements.
TIRFSettingsVector	getTIRFSettings_List() Returns the list of TIRFSettings elements.
void	addToTIRFSettings_List(TIRFSettings value, boolean validate) Adds a new TIRFSettings element to this object.
void	addToTIRFSettings_List(TIRFSettings value) Adds a new TIRFSettings element to this object.
void	clearTIRFSettings_List() Clear the list of TIRFSettings.
void	setLightPathMap(LightPath_Type_InlineLightPathMap value, boolean validate) Sets the value of the LightPathMap element.
void	setLightPathMap(LightPath_Type_InlineLightPathMap value) Sets the value of the LightPathMap element.
LightPath_Type_InlineLightPathMap	getLightPathMap() Returns the value of the LightPathMap element.
void	resetLightPathMap() Resets the LightPathMap element to an unset state.
boolean	hasLightPathMap() Checks whether the optional LightPathMap element is present.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.

Protected Functions inherited from com.inscoper.nbo.LightPath_Type

	Name
	LightPath_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.LightPath;

Represents the XML element LightPath.

This element holds a description of the Light Path associated with the Acquisition of this Channel.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.LightPath_Type.delete

function LightPath

public LightPath()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.LightPath_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.LightPath_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.LightPath_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.LightPath_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.LightPath_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.LightPath_Type.fromJsonFile

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file

Reimplements: com.inscoper.nbo.LightPath_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.LightPath_Type.fromJsonString

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string

Reimplements: com.inscoper.nbo.LightPath_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.LightPath_Type.fromXmlFile

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file

Reimplements: com.inscoper.nbo.LightPath_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.LightPath_Type.fromXmlString

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string

Reimplements: com.inscoper.nbo.LightPath_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename,
    boolean validate
)

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.

Reimplements: com.inscoper.nbo.LightPath_Type.toXmlFile

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file

Reimplements: com.inscoper.nbo.LightPath_Type.toXmlFile

function toXmlString

public String toXmlString(
    boolean validate
)

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

Reimplements: com.inscoper.nbo.LightPath_Type.toXmlString

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.LightPath_Type.toXmlString

function __internal_create

public static LightPath __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.LightPath_Type.__internal_create

function fromBase

public static LightPath fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

• base The base class to cast

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

Reimplements: com.inscoper.nbo.LightPath_Type.fromBase

Protected Functions Documentation

function LightPath

protected LightPath(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.LightPath_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.LightPath_Type.finalize

function getCPtr

protected static long getCPtr(
    LightPath obj
)

---

Updated on 2026-06-22 at 17:06:30 +0200