com.inscoper.nbo.TransmissionWavelengthRangeSettings¶

Represents the XML element TransmissionWavelengthRangeSettings. More...

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

Public Functions¶

	Name
synchronized void	delete()
	TransmissionWavelengthRangeSettings()
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	setTransmittance(PercentFraction_Type value, boolean validate) Sets the value of the Transmittance attribute.
void	setTransmittance(PercentFraction_Type value) Sets the value of the Transmittance attribute.
PercentFraction_Type	getTransmittance() Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
boolean	hasTransmittance() Checks whether the optional Transmittance attribute is present.
TransmissionWavelengthRangeSettings	__internal_create(long cPtr, boolean own)
TransmissionWavelengthRangeSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a TransmissionWavelengthRangeSettings.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.WavelengthRangeSettingsType_Type

	Name
	WavelengthRangeSettingsType_Type()
void	setCutOn(PositiveFloat_Type value, boolean validate) Sets the value of the CutOn attribute.
void	setCutOn(PositiveFloat_Type value) Sets the value of the CutOn attribute.
PositiveFloat_Type	getCutOn() Returns the value of the CutOn attribute.
void	resetCutOn() Resets the CutOn attribute to an unset state.
boolean	hasCutOn() Checks whether the optional CutOn attribute is present.
void	setCutOff(PositiveFloat_Type value, boolean validate) Sets the value of the CutOff attribute.
void	setCutOff(PositiveFloat_Type value) Sets the value of the CutOff attribute.
PositiveFloat_Type	getCutOff() Returns the value of the CutOff attribute.
void	resetCutOff() Resets the CutOff attribute to an unset state.
boolean	hasCutOff() Checks whether the optional CutOff attribute is present.
void	setWavelengthUnit(UnitsLength_Type value, boolean validate) Sets the value of the WavelengthUnit attribute.
void	setWavelengthUnit(UnitsLength_Type value) Sets the value of the WavelengthUnit attribute.
UnitsLength_Type	getWavelengthUnit() Returns the value of the WavelengthUnit attribute.
void	resetWavelengthUnit() Resets the WavelengthUnit attribute to an unset state.
boolean	hasWavelengthUnit() Checks whether the optional WavelengthUnit attribute is present.

Protected Functions inherited from com.inscoper.nbo.WavelengthRangeSettingsType_Type

	Name
	WavelengthRangeSettingsType_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.TransmissionWavelengthRangeSettings;

Represents the XML element TransmissionWavelengthRangeSettings.

This element records the range of Transmission Wavelengths that were set for this optical component during the Acquisition of this Image. It also records the maximum amount of light transmitted. Multiple of this elements can be used.

Public Functions Documentation¶

function delete¶

function TransmissionWavelengthRangeSettings¶

function getTypeName¶

function getXMLName¶

function 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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_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.WavelengthRangeSettingsType_Type.toXmlString

function setTransmittance¶

public void setTransmittance(
    PercentFraction_Type value,
    boolean validate
)

Sets the value of the Transmittance attribute.

Parameters:

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