com.inscoper.nbo.AcoustoOpticalDeviceSettings_Type¶

Represents the XML complex type AcoustoOpticalDeviceSettings. More...

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

Inherited by com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings, com.inscoper.nbo.AcoustoOpticalDeflectorSettings, com.inscoper.nbo.AcoustoOpticalModulatorSettings, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings

Public Functions¶

	Name
synchronized void	delete()
	AcoustoOpticalDeviceSettings_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	setID(AcoustoOpticalDeviceID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(AcoustoOpticalDeviceID_Type value) Sets the value of the ID attribute.
AcoustoOpticalDeviceID_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	setDiffractionEfficiency(PercentFraction_Type value, boolean validate) Sets the value of the DiffractionEfficiency attribute.
void	setDiffractionEfficiency(PercentFraction_Type value) Sets the value of the DiffractionEfficiency attribute.
PercentFraction_Type	getDiffractionEfficiency() Returns the value of the DiffractionEfficiency attribute.
void	resetDiffractionEfficiency() Resets the DiffractionEfficiency attribute to an unset state.
boolean	hasDiffractionEfficiency() Checks whether the optional DiffractionEfficiency attribute is present.
void	setAcousticVelocity(float value, boolean validate) Sets the value of the AcousticVelocity attribute.
void	setAcousticVelocity(float value) Sets the value of the AcousticVelocity attribute.
float	getAcousticVelocity() Returns the value of the AcousticVelocity attribute.
void	resetAcousticVelocity() Resets the AcousticVelocity attribute to an unset state.
boolean	hasAcousticVelocity() Checks whether the AcousticVelocity attribute is present.
void	setAcousticVelocityUnit(UnitsVelocity_Type value, boolean validate) Sets the value of the AcousticVelocityUnit attribute.
void	setAcousticVelocityUnit(UnitsVelocity_Type value) Sets the value of the AcousticVelocityUnit attribute.
UnitsVelocity_Type	getAcousticVelocityUnit() Returns the value of the AcousticVelocityUnit attribute.
void	resetAcousticVelocityUnit() Resets the AcousticVelocityUnit attribute to an unset state.
boolean	hasAcousticVelocityUnit() Checks whether the optional AcousticVelocityUnit attribute is present.
void	setAcousticFrequency(float value, boolean validate) Sets the value of the AcousticFrequency attribute.
void	setAcousticFrequency(float value) Sets the value of the AcousticFrequency attribute.
float	getAcousticFrequency() Returns the value of the AcousticFrequency attribute.
void	resetAcousticFrequency() Resets the AcousticFrequency attribute to an unset state.
boolean	hasAcousticFrequency() Checks whether the AcousticFrequency attribute is present.
void	setAcousticFrequencyUnit(UnitsFrequency_Type value, boolean validate) Sets the value of the AcousticFrequencyUnit attribute.
void	setAcousticFrequencyUnit(UnitsFrequency_Type value) Sets the value of the AcousticFrequencyUnit attribute.
UnitsFrequency_Type	getAcousticFrequencyUnit() Returns the value of the AcousticFrequencyUnit attribute.
void	resetAcousticFrequencyUnit() Resets the AcousticFrequencyUnit attribute to an unset state.
boolean	hasAcousticFrequencyUnit() Checks whether the optional AcousticFrequencyUnit attribute is present.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value, boolean validate) Sets the list of TransmittanceProfileFile elements.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value) Sets the list of TransmittanceProfileFile elements.
TransmittanceProfileFileVector	getTransmittanceProfileFile_List() Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value, boolean validate) Adds a new TransmittanceProfileFile element to this object.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setReflectanceProfileFile_List(ReflectanceProfileFileVector value, boolean validate) Sets the list of ReflectanceProfileFile elements.
void	setReflectanceProfileFile_List(ReflectanceProfileFileVector value) Sets the list of ReflectanceProfileFile elements.
ReflectanceProfileFileVector	getReflectanceProfileFile_List() Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(ReflectanceProfileFile value, boolean validate) Adds a new ReflectanceProfileFile element to this object.
void	addToReflectanceProfileFile_List(ReflectanceProfileFile value) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
void	setTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettingsVector value, boolean validate) Sets the list of TransmissionWavelengthRangeSettings elements.
void	setTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettingsVector value) Sets the list of TransmissionWavelengthRangeSettings elements.
TransmissionWavelengthRangeSettingsVector	getTransmissionWavelengthRangeSettings_List() Returns the list of TransmissionWavelengthRangeSettings elements.
void	addToTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettings value, boolean validate) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	addToTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettings value) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	clearTransmissionWavelengthRangeSettings_List() Clear the list of TransmissionWavelengthRangeSettings.
void	setReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettingsVector value, boolean validate) Sets the list of ReflectionWavelengthRangeSettings elements.
void	setReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettingsVector value) Sets the list of ReflectionWavelengthRangeSettings elements.
ReflectionWavelengthRangeSettingsVector	getReflectionWavelengthRangeSettings_List() Returns the list of ReflectionWavelengthRangeSettings elements.
void	addToReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettings value, boolean validate) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	addToReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettings value) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	clearReflectionWavelengthRangeSettings_List() Clear the list of ReflectionWavelengthRangeSettings.
AcoustoOpticalDeviceSettings_Type	__internal_create(long cPtr, boolean own)
AcoustoOpticalDeviceSettings_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a AcoustoOpticalDeviceSettings_Type.

Protected Functions¶

	Name
	AcoustoOpticalDeviceSettings_Type(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(AcoustoOpticalDeviceSettings_Type 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.AcoustoOpticalDeviceSettings_Type;

Represents the XML complex type AcoustoOpticalDeviceSettings.

This element refers to the Acousto Optical Device used to acquire this image and it holds the settings that were applied to it during this Acquisition.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.Settings_Type.delete

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.delete, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.delete, com.inscoper.nbo.AcoustoOpticalModulatorSettings.delete, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.delete

function AcoustoOpticalDeviceSettings_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Settings_Type.getTypeName

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.getTypeName, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.getTypeName, com.inscoper.nbo.AcoustoOpticalModulatorSettings.getTypeName, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.Settings_Type.getXMLName

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.getXMLName, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.getXMLName, com.inscoper.nbo.AcoustoOpticalModulatorSettings.getXMLName, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.Settings_Type.getNBOType

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.getNBOType, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.getNBOType, com.inscoper.nbo.AcoustoOpticalModulatorSettings.getNBOType, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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.Settings_Type.getChildren

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.getChildren, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.getChildren, com.inscoper.nbo.AcoustoOpticalModulatorSettings.getChildren, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.getSubElements, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.getSubElements, com.inscoper.nbo.AcoustoOpticalModulatorSettings.getSubElements, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromJsonFile, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromJsonFile, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromJsonFile, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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.Settings_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromJsonFile, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromJsonFile, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromJsonFile, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromJsonString, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromJsonString, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromJsonString, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromJsonString, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromJsonString, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromJsonString, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromXmlFile, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromXmlFile, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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.Settings_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromXmlFile, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromXmlFile, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromXmlString, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromXmlString, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromXmlString, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromXmlString, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.toXmlFile, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.toXmlFile, com.inscoper.nbo.AcoustoOpticalModulatorSettings.toXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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.Settings_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.toXmlFile, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.toXmlFile, com.inscoper.nbo.AcoustoOpticalModulatorSettings.toXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.toXmlString, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.toXmlString, com.inscoper.nbo.AcoustoOpticalModulatorSettings.toXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.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.Settings_Type.toXmlString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.toXmlString, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.toXmlString, com.inscoper.nbo.AcoustoOpticalModulatorSettings.toXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.toXmlString

function setID¶

public void setID(
    AcoustoOpticalDeviceID_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.

This is the Unique Identifier of the device used in this case.

function setID¶

function getID¶

function resetID¶

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

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

This is the Unique Identifier of the device used in this case.

function setDiffractionEfficiency¶

public void setDiffractionEfficiency(
    PercentFraction_Type value,
    boolean validate
)

Sets the value of the DiffractionEfficiency attribute.

Parameters:

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

This field records a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

function setDiffractionEfficiency¶

public void setDiffractionEfficiency(
    PercentFraction_Type value
)

Sets the value of the DiffractionEfficiency attribute.

Parameters:

value The value to set

This field records a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

function getDiffractionEfficiency¶

public PercentFraction_Type getDiffractionEfficiency()

Returns the value of the DiffractionEfficiency attribute.

Return: The value of the attribute

This field records a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

function resetDiffractionEfficiency¶

public void resetDiffractionEfficiency()

Resets the DiffractionEfficiency attribute to an unset state.

This field records a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

function hasDiffractionEfficiency¶

public boolean hasDiffractionEfficiency()

Checks whether the optional DiffractionEfficiency attribute is present.

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

This field records a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.

function setAcousticVelocity¶

public void setAcousticVelocity(
    float value,
    boolean validate
)

Sets the value of the AcousticVelocity attribute.

Parameters:

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

This field records the acoustic wave transit time across the crystal used during this Acquisition.

function setAcousticVelocity¶

public void setAcousticVelocity(
    float value
)

Sets the value of the AcousticVelocity attribute.

Parameters:

value The value to set

This field records the acoustic wave transit time across the crystal used during this Acquisition.

function getAcousticVelocity¶

public float getAcousticVelocity()

Returns the value of the AcousticVelocity attribute.

Return: The value of the attribute

This field records the acoustic wave transit time across the crystal used during this Acquisition.

function resetAcousticVelocity¶

function hasAcousticVelocity¶

public boolean hasAcousticVelocity()

Checks whether the AcousticVelocity attribute is present.

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

This field records the acoustic wave transit time across the crystal used during this Acquisition.

function setAcousticVelocityUnit¶

public void setAcousticVelocityUnit(
    UnitsVelocity_Type value,
    boolean validate
)

Sets the value of the AcousticVelocityUnit 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 setAcousticVelocityUnit¶

public void setAcousticVelocityUnit(
    UnitsVelocity_Type value
)

Sets the value of the AcousticVelocityUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAcousticVelocityUnit¶

function resetAcousticVelocityUnit¶

function hasAcousticVelocityUnit¶

public boolean hasAcousticVelocityUnit()

Checks whether the optional AcousticVelocityUnit attribute is present.

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

No description available in the XSD standard.

function setAcousticFrequency¶

public void setAcousticFrequency(
    float value,
    boolean validate
)

Sets the value of the AcousticFrequency attribute.

Parameters:

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

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

function setAcousticFrequency¶

public void setAcousticFrequency(
    float value
)

Sets the value of the AcousticFrequency attribute.

Parameters:

value The value to set

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

function getAcousticFrequency¶

public float getAcousticFrequency()

Returns the value of the AcousticFrequency attribute.

Return: The value of the attribute

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

function resetAcousticFrequency¶

public void resetAcousticFrequency()

Resets the AcousticFrequency attribute to an unset state.

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

function hasAcousticFrequency¶

public boolean hasAcousticFrequency()

Checks whether the AcousticFrequency attribute is present.

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

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

function setAcousticFrequencyUnit¶

public void setAcousticFrequencyUnit(
    UnitsFrequency_Type value,
    boolean validate
)

Sets the value of the AcousticFrequencyUnit 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 setAcousticFrequencyUnit¶

public void setAcousticFrequencyUnit(
    UnitsFrequency_Type value
)

Sets the value of the AcousticFrequencyUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAcousticFrequencyUnit¶

function resetAcousticFrequencyUnit¶

function hasAcousticFrequencyUnit¶

public boolean hasAcousticFrequencyUnit()

Checks whether the optional AcousticFrequencyUnit attribute is present.

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

No description available in the XSD standard.

function setTransmittanceProfileFile_List¶

public void setTransmittanceProfileFile_List(
    TransmittanceProfileFileVector value,
    boolean validate
)

Sets the list of TransmittanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function setTransmittanceProfileFile_List¶

public void setTransmittanceProfileFile_List(
    TransmittanceProfileFileVector value
)

Sets the list of TransmittanceProfileFile elements.

Parameters:

value The new list of TransmittanceProfileFile elements

No description available in the XSD standard.

function getTransmittanceProfileFile_List¶

public TransmittanceProfileFileVector getTransmittanceProfileFile_List()

Returns the list of TransmittanceProfileFile elements.

Return: The list of TransmittanceProfileFile elements

No description available in the XSD standard.

function addToTransmittanceProfileFile_List¶

public void addToTransmittanceProfileFile_List(
    TransmittanceProfileFile value,
    boolean validate
)

Adds a new TransmittanceProfileFile 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 addToTransmittanceProfileFile_List¶

public void addToTransmittanceProfileFile_List(
    TransmittanceProfileFile value
)

Adds a new TransmittanceProfileFile element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearTransmittanceProfileFile_List¶

function setReflectanceProfileFile_List¶

public void setReflectanceProfileFile_List(
    ReflectanceProfileFileVector value,
    boolean validate
)

Sets the list of ReflectanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function setReflectanceProfileFile_List¶

public void setReflectanceProfileFile_List(
    ReflectanceProfileFileVector value
)

Sets the list of ReflectanceProfileFile elements.

Parameters:

value The new list of ReflectanceProfileFile elements

No description available in the XSD standard.

function getReflectanceProfileFile_List¶

public ReflectanceProfileFileVector getReflectanceProfileFile_List()

Returns the list of ReflectanceProfileFile elements.

Return: The list of ReflectanceProfileFile elements

No description available in the XSD standard.

function addToReflectanceProfileFile_List¶

public void addToReflectanceProfileFile_List(
    ReflectanceProfileFile value,
    boolean validate
)

Adds a new ReflectanceProfileFile 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 addToReflectanceProfileFile_List¶

public void addToReflectanceProfileFile_List(
    ReflectanceProfileFile value
)

Adds a new ReflectanceProfileFile element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearReflectanceProfileFile_List¶

function setTransmissionWavelengthRangeSettings_List¶

public void setTransmissionWavelengthRangeSettings_List(
    TransmissionWavelengthRangeSettingsVector value,
    boolean validate
)

Sets the list of TransmissionWavelengthRangeSettings elements.

Parameters:

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

No description available in the XSD standard.

function setTransmissionWavelengthRangeSettings_List¶

public void setTransmissionWavelengthRangeSettings_List(
    TransmissionWavelengthRangeSettingsVector value
)

Sets the list of TransmissionWavelengthRangeSettings elements.

Parameters:

value The new list of TransmissionWavelengthRangeSettings elements

No description available in the XSD standard.

function getTransmissionWavelengthRangeSettings_List¶

public TransmissionWavelengthRangeSettingsVector getTransmissionWavelengthRangeSettings_List()

Returns the list of TransmissionWavelengthRangeSettings elements.

Return: The list of TransmissionWavelengthRangeSettings elements

No description available in the XSD standard.

function addToTransmissionWavelengthRangeSettings_List¶

public void addToTransmissionWavelengthRangeSettings_List(
    TransmissionWavelengthRangeSettings value,
    boolean validate
)

Adds a new TransmissionWavelengthRangeSettings 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 addToTransmissionWavelengthRangeSettings_List¶

public void addToTransmissionWavelengthRangeSettings_List(
    TransmissionWavelengthRangeSettings value
)

Adds a new TransmissionWavelengthRangeSettings element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearTransmissionWavelengthRangeSettings_List¶

function setReflectionWavelengthRangeSettings_List¶

public void setReflectionWavelengthRangeSettings_List(
    ReflectionWavelengthRangeSettingsVector value,
    boolean validate
)

Sets the list of ReflectionWavelengthRangeSettings elements.

Parameters:

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

No description available in the XSD standard.

function setReflectionWavelengthRangeSettings_List¶

public void setReflectionWavelengthRangeSettings_List(
    ReflectionWavelengthRangeSettingsVector value
)

Sets the list of ReflectionWavelengthRangeSettings elements.

Parameters:

value The new list of ReflectionWavelengthRangeSettings elements

No description available in the XSD standard.

function getReflectionWavelengthRangeSettings_List¶

public ReflectionWavelengthRangeSettingsVector getReflectionWavelengthRangeSettings_List()

Returns the list of ReflectionWavelengthRangeSettings elements.

Return: The list of ReflectionWavelengthRangeSettings elements

No description available in the XSD standard.

function addToReflectionWavelengthRangeSettings_List¶

public void addToReflectionWavelengthRangeSettings_List(
    ReflectionWavelengthRangeSettings value,
    boolean validate
)

Adds a new ReflectionWavelengthRangeSettings 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 addToReflectionWavelengthRangeSettings_List¶

public void addToReflectionWavelengthRangeSettings_List(
    ReflectionWavelengthRangeSettings value
)

Adds a new ReflectionWavelengthRangeSettings element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearReflectionWavelengthRangeSettings_List¶

function __internal_create¶

public static AcoustoOpticalDeviceSettings_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.__internal_create

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.__internal_create, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.__internal_create, com.inscoper.nbo.AcoustoOpticalModulatorSettings.__internal_create, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.__internal_create

function fromBase¶

public static AcoustoOpticalDeviceSettings_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a AcoustoOpticalDeviceSettings_Type.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.Settings_Type.fromBase

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.fromBase, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.fromBase, com.inscoper.nbo.AcoustoOpticalModulatorSettings.fromBase, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.fromBase

Protected Functions Documentation¶

function AcoustoOpticalDeviceSettings_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.swigSetCMemOwn, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.swigSetCMemOwn, com.inscoper.nbo.AcoustoOpticalModulatorSettings.swigSetCMemOwn, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.Settings_Type.finalize

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitterSettings.finalize, com.inscoper.nbo.AcoustoOpticalDeflectorSettings.finalize, com.inscoper.nbo.AcoustoOpticalModulatorSettings.finalize, com.inscoper.nbo.AcoustoOpticalTuneableFilterSettings.finalize