com.inscoper.nbo.LightSourceSettings¶

Represents the XML element LightSourceSettings. More...

Inherits from com.inscoper.nbo.Settings_Type, com.inscoper.nbo.Reference_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	LightSourceSettings()
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.
void	setID(LightSourceID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LightSourceID_Type value) Sets the value of the ID attribute.
LightSourceID_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	setIlluminationPowerSettings(float value, boolean validate) Sets the value of the IlluminationPowerSettings attribute.
void	setIlluminationPowerSettings(float value) Sets the value of the IlluminationPowerSettings attribute.
float	getIlluminationPowerSettings() Returns the value of the IlluminationPowerSettings attribute.
void	resetIlluminationPowerSettings() Resets the IlluminationPowerSettings attribute to an unset state.
boolean	hasIlluminationPowerSettings() Checks whether the IlluminationPowerSettings attribute is present.
void	setlluminationPowerSettingsUnit(UnitsPower_Type value, boolean validate) Sets the value of the lluminationPowerSettingsUnit attribute.
void	setlluminationPowerSettingsUnit(UnitsPower_Type value) Sets the value of the lluminationPowerSettingsUnit attribute.
UnitsPower_Type	getlluminationPowerSettingsUnit() Returns the value of the lluminationPowerSettingsUnit attribute.
void	resetlluminationPowerSettingsUnit() Resets the lluminationPowerSettingsUnit attribute to an unset state.
boolean	haslluminationPowerSettingsUnit() Checks whether the optional lluminationPowerSettingsUnit attribute is present.
void	setAttenuation(PercentFraction_Type value, boolean validate) Sets the value of the Attenuation attribute.
void	setAttenuation(PercentFraction_Type value) Sets the value of the Attenuation attribute.
PercentFraction_Type	getAttenuation() Returns the value of the Attenuation attribute.
void	resetAttenuation() Resets the Attenuation attribute to an unset state.
boolean	hasAttenuation() Checks whether the optional Attenuation attribute is present.
void	setAttenuationMethod(String value, boolean validate) Sets the value of the AttenuationMethod attribute.
void	setAttenuationMethod(String value) Sets the value of the AttenuationMethod attribute.
String	getAttenuationMethod() Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
boolean	hasAttenuationMethod() Checks whether the AttenuationMethod attribute is present.
void	setUsedAcoustoOpticalDevice(boolean value, boolean validate) Sets the value of the UsedAcoustoOpticalDevice attribute.
void	setUsedAcoustoOpticalDevice(boolean value) Sets the value of the UsedAcoustoOpticalDevice attribute.
boolean	getUsedAcoustoOpticalDevice() Returns the value of the UsedAcoustoOpticalDevice attribute.
void	resetUsedAcoustoOpticalDevice() Resets the UsedAcoustoOpticalDevice attribute to an unset state.
boolean	hasUsedAcoustoOpticalDevice() Checks whether the UsedAcoustoOpticalDevice attribute is present.
LightSourceSettings	__internal_create(long cPtr, boolean own)
LightSourceSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a LightSourceSettings.
StringSet	getAttenuationMethodAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type()

Protected Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_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.LightSourceSettings;

Represents the XML element LightSourceSettings.

This element holds the Setting applied to a Light Source used in the Light Path during the acquisition of this Channel as well as a reference to the LightSource (the ID attribute) in question.

Public Functions Documentation¶

function delete¶

function LightSourceSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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.Settings_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.Settings_Type.fromJsonFile

function 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.Settings_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.Settings_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.Settings_Type.fromXmlFile

function 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.Settings_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.Settings_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.Settings_Type.toXmlFile

function 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.Settings_Type.toXmlString

function toXmlString¶

function setID¶

public void setID(
    LightSourceID_Type value,
    boolean validate
)

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

function getID¶

function resetID¶

function hasID¶

function setIlluminationPowerSettings¶

public void setIlluminationPowerSettings(
    float value,
    boolean validate
)

Sets the value of the IlluminationPowerSettings attribute.

Parameters:

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

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function setIlluminationPowerSettings¶

public void setIlluminationPowerSettings(
    float value
)

Sets the value of the IlluminationPowerSettings attribute.

Parameters:

value The value to set

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function getIlluminationPowerSettings¶

public float getIlluminationPowerSettings()

Returns the value of the IlluminationPowerSettings attribute.

Return: The value of the attribute

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function resetIlluminationPowerSettings¶

public void resetIlluminationPowerSettings()

Resets the IlluminationPowerSettings attribute to an unset state.

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function hasIlluminationPowerSettings¶

public boolean hasIlluminationPowerSettings()

Checks whether the IlluminationPowerSettings attribute is present.

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

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function setlluminationPowerSettingsUnit¶

public void setlluminationPowerSettingsUnit(
    UnitsPower_Type value,
    boolean validate
)

Sets the value of the lluminationPowerSettingsUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setlluminationPowerSettingsUnit¶

public void setlluminationPowerSettingsUnit(
    UnitsPower_Type value
)

Sets the value of the lluminationPowerSettingsUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getlluminationPowerSettingsUnit¶

public UnitsPower_Type getlluminationPowerSettingsUnit()

Returns the value of the lluminationPowerSettingsUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetlluminationPowerSettingsUnit¶

function haslluminationPowerSettingsUnit¶

public boolean haslluminationPowerSettingsUnit()

Checks whether the optional lluminationPowerSettingsUnit attribute is present.

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

No description available in the XSD standard.

function setAttenuation¶

public void setAttenuation(
    PercentFraction_Type value,
    boolean validate
)

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 records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function setAttenuation¶

public void setAttenuation(
    PercentFraction_Type value
)

Sets the value of the Attenuation attribute.

Parameters:

value The value to set

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function getAttenuation¶

public PercentFraction_Type getAttenuation()

Returns the value of the Attenuation attribute.

Return: The value of the attribute

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function resetAttenuation¶

public void resetAttenuation()

Resets the Attenuation attribute to an unset state.

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function hasAttenuation¶

public boolean hasAttenuation()

Checks whether the optional Attenuation attribute is present.

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

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function setAttenuationMethod¶

public void setAttenuationMethod(
    String value,
    boolean validate
)

Sets the value of the AttenuationMethod attribute.

Parameters:

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

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function setAttenuationMethod¶

public void setAttenuationMethod(
    String value
)

Sets the value of the AttenuationMethod attribute.

Parameters:

value The value to set

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function getAttenuationMethod¶

public String getAttenuationMethod()

Returns the value of the AttenuationMethod attribute.

Return: The value of the attribute

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function resetAttenuationMethod¶

public void resetAttenuationMethod()

Resets the AttenuationMethod attribute to an unset state.

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function hasAttenuationMethod¶

public boolean hasAttenuationMethod()

Checks whether the AttenuationMethod attribute is present.

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

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function setUsedAcoustoOpticalDevice¶

public void setUsedAcoustoOpticalDevice(
    boolean value,
    boolean validate
)

Sets the value of the UsedAcoustoOpticalDevice attribute.

Parameters:

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

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function setUsedAcoustoOpticalDevice¶

public void setUsedAcoustoOpticalDevice(
    boolean value
)

Sets the value of the UsedAcoustoOpticalDevice attribute.

Parameters:

value The value to set

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function getUsedAcoustoOpticalDevice¶

public boolean getUsedAcoustoOpticalDevice()

Returns the value of the UsedAcoustoOpticalDevice attribute.

Return: The value of the attribute

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function resetUsedAcoustoOpticalDevice¶

public void resetUsedAcoustoOpticalDevice()

Resets the UsedAcoustoOpticalDevice attribute to an unset state.

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function hasUsedAcoustoOpticalDevice¶

public boolean hasUsedAcoustoOpticalDevice()

Checks whether the UsedAcoustoOpticalDevice attribute is present.

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

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function __internal_create¶

function fromBase¶

public static LightSourceSettings fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a LightSourceSettings.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.Settings_Type.fromBase

function getAttenuationMethodAllowedValues¶

public static StringSet getAttenuationMethodAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

com.inscoper.nbo.LightSourceSettings¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function LightSourceSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setID¶

function setID¶

function getID¶

function resetID¶

function hasID¶

function setIlluminationPowerSettings¶

function setIlluminationPowerSettings¶

function getIlluminationPowerSettings¶

function resetIlluminationPowerSettings¶

function hasIlluminationPowerSettings¶

function setlluminationPowerSettingsUnit¶

function setlluminationPowerSettingsUnit¶

function getlluminationPowerSettingsUnit¶

function resetlluminationPowerSettingsUnit¶

function haslluminationPowerSettingsUnit¶

function setAttenuation¶

function setAttenuation¶

function getAttenuation¶

function resetAttenuation¶

function hasAttenuation¶

function setAttenuationMethod¶

function setAttenuationMethod¶

function getAttenuationMethod¶

function resetAttenuationMethod¶

function hasAttenuationMethod¶

function setUsedAcoustoOpticalDevice¶

function setUsedAcoustoOpticalDevice¶

function getUsedAcoustoOpticalDevice¶

function resetUsedAcoustoOpticalDevice¶

function hasUsedAcoustoOpticalDevice¶

function __internal_create¶

function fromBase¶

function getAttenuationMethodAllowedValues¶

Protected Functions Documentation¶

function LightSourceSettings¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶