com.inscoper.nbo.TransmittanceRangeType_Type¶

Represents the XML complex type TransmittanceRangeType. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Inherited by com.inscoper.nbo.TransmittanceRange

Public Functions¶

	Name
synchronized void	delete()
	TransmittanceRangeType_Type()
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	setWavelength(PositiveFloat_Type value, boolean validate) Sets the value of the Wavelength attribute.
void	setWavelength(PositiveFloat_Type value) Sets the value of the Wavelength attribute.
PositiveFloat_Type	getWavelength() Returns the value of the Wavelength attribute.
void	resetWavelength() Resets the Wavelength attribute to an unset state.
boolean	hasWavelength() Checks whether the optional Wavelength attribute is present.
void	setFWHMBandwidth(PositiveFloat_Type value, boolean validate) Sets the value of the FWHMBandwidth attribute.
void	setFWHMBandwidth(PositiveFloat_Type value) Sets the value of the FWHMBandwidth attribute.
PositiveFloat_Type	getFWHMBandwidth() Returns the value of the FWHMBandwidth attribute.
void	resetFWHMBandwidth() Resets the FWHMBandwidth attribute to an unset state.
boolean	hasFWHMBandwidth() Checks whether the optional FWHMBandwidth 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.
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.
TransmittanceRangeType_Type	__internal_create(long cPtr, boolean own)
TransmittanceRangeType_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a TransmittanceRangeType_Type.

Protected Functions¶

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

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.TransmittanceRangeType_Type;

Represents the XML complex type TransmittanceRangeType.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

Public Functions Documentation¶

function delete¶

function TransmittanceRangeType_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

Reimplemented by: com.inscoper.nbo.TransmittanceRange.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

Reimplemented by: com.inscoper.nbo.TransmittanceRange.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.NBOBaseClass.getChildren

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.NBOBaseClass.getSubElements

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.

Reimplemented by: com.inscoper.nbo.TransmittanceRange.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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.

Reimplemented by: com.inscoper.nbo.TransmittanceRange.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplemented by: com.inscoper.nbo.TransmittanceRange.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

Reimplemented by: com.inscoper.nbo.TransmittanceRange.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplemented by: com.inscoper.nbo.TransmittanceRange.toXmlString

function setWavelength¶

public void setWavelength(
    PositiveFloat_Type value,
    boolean validate
)

Sets the value of the Wavelength attribute.

Parameters:

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

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function setWavelength¶

public void setWavelength(
    PositiveFloat_Type value
)

Sets the value of the Wavelength attribute.

Parameters:

value The value to set

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function getWavelength¶

public PositiveFloat_Type getWavelength()

Returns the value of the Wavelength attribute.

Return: The value of the attribute

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function resetWavelength¶

public void resetWavelength()

Resets the Wavelength attribute to an unset state.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function hasWavelength¶

public boolean hasWavelength()

Checks whether the optional Wavelength attribute is present.

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

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

function setFWHMBandwidth¶

public void setFWHMBandwidth(
    PositiveFloat_Type value,
    boolean validate
)

Sets the value of the FWHMBandwidth attribute.

Parameters:

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

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function setFWHMBandwidth¶

public void setFWHMBandwidth(
    PositiveFloat_Type value
)

Sets the value of the FWHMBandwidth attribute.

Parameters:

value The value to set

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function getFWHMBandwidth¶

public PositiveFloat_Type getFWHMBandwidth()

Returns the value of the FWHMBandwidth attribute.

Return: The value of the attribute

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function resetFWHMBandwidth¶

public void resetFWHMBandwidth()

Resets the FWHMBandwidth attribute to an unset state.

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function hasFWHMBandwidth¶

public boolean hasFWHMBandwidth()

Checks whether the optional FWHMBandwidth attribute is present.

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

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

function setWavelengthUnit¶

public void setWavelengthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the WavelengthUnit 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 setWavelengthUnit¶

function getWavelengthUnit¶

function resetWavelengthUnit¶

function hasWavelengthUnit¶

public boolean hasWavelengthUnit()

Checks whether the optional WavelengthUnit attribute is present.

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

No description available in the XSD standard.

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.