com.inscoper.nbo.AcoustoOpticalDevice_Type¶

Represents the XML complex type AcoustoOpticalDevice. More...

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

Inherited by com.inscoper.nbo.AcoustoOpticalBeamSplitter, com.inscoper.nbo.AcoustoOpticalDeflector, com.inscoper.nbo.AcoustoOpticalModulator, com.inscoper.nbo.AcoustoOpticalTuneableFilter

Public Functions¶

	Name
synchronized void	delete()
	AcoustoOpticalDevice_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	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	setContrastRatio(PercentFraction_Type value, boolean validate) Sets the value of the ContrastRatio attribute.
void	setContrastRatio(PercentFraction_Type value) Sets the value of the ContrastRatio attribute.
PercentFraction_Type	getContrastRatio() Returns the value of the ContrastRatio attribute.
void	resetContrastRatio() Resets the ContrastRatio attribute to an unset state.
boolean	hasContrastRatio() Checks whether the optional ContrastRatio attribute is present.
void	setCoating(String value, boolean validate) Sets the value of the Coating attribute.
void	setCoating(String value) Sets the value of the Coating attribute.
String	getCoating() Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
boolean	hasCoating() Checks whether the Coating attribute is present.
void	setAttenuationMethod(AttenuationMethodType_Type value, boolean validate) Sets the value of the AttenuationMethod attribute.
void	setAttenuationMethod(AttenuationMethodType_Type value) Sets the value of the AttenuationMethod attribute.
AttenuationMethodType_Type	getAttenuationMethod() Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
boolean	hasAttenuationMethod() Checks whether the optional AttenuationMethod attribute is present.
void	setAttenuationCoefficient(float value, boolean validate) Sets the value of the AttenuationCoefficient attribute.
void	setAttenuationCoefficient(float value) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
boolean	hasAttenuationCoefficient() Checks whether the AttenuationCoefficient attribute is present.
void	setTuningAccuracy(float value, boolean validate) Sets the value of the TuningAccuracy attribute.
void	setTuningAccuracy(float value) Sets the value of the TuningAccuracy attribute.
float	getTuningAccuracy() Returns the value of the TuningAccuracy attribute.
void	resetTuningAccuracy() Resets the TuningAccuracy attribute to an unset state.
boolean	hasTuningAccuracy() Checks whether the TuningAccuracy attribute is present.
void	setTuningAccuracyUnit(UnitsLength_Type value, boolean validate) Sets the value of the TuningAccuracyUnit attribute.
void	setTuningAccuracyUnit(UnitsLength_Type value) Sets the value of the TuningAccuracyUnit attribute.
UnitsLength_Type	getTuningAccuracyUnit() Returns the value of the TuningAccuracyUnit attribute.
void	resetTuningAccuracyUnit() Resets the TuningAccuracyUnit attribute to an unset state.
boolean	hasTuningAccuracyUnit() Checks whether the optional TuningAccuracyUnit attribute is present.
void	setPolarization(PolarizationMode_Type value, boolean validate) Sets the value of the Polarization attribute.
void	setPolarization(PolarizationMode_Type value) Sets the value of the Polarization attribute.
PolarizationMode_Type	getPolarization() Returns the value of the Polarization attribute.
void	resetPolarization() Resets the Polarization attribute to an unset state.
boolean	hasPolarization() Checks whether the optional Polarization attribute is present.
void	setBragg(boolean value, boolean validate) Sets the value of the Bragg attribute.
void	setBragg(boolean value) Sets the value of the Bragg attribute.
boolean	getBragg() Returns the value of the Bragg attribute.
void	resetBragg() Resets the Bragg attribute to an unset state.
boolean	hasBragg() Checks whether the Bragg attribute is present.
void	setTuningResolution(float value, boolean validate) Sets the value of the TuningResolution attribute.
void	setTuningResolution(float value) Sets the value of the TuningResolution attribute.
float	getTuningResolution() Returns the value of the TuningResolution attribute.
void	resetTuningResolution() Resets the TuningResolution attribute to an unset state.
boolean	hasTuningResolution() Checks whether the TuningResolution attribute is present.
void	setTuningResolutionUnit(UnitsLength_Type value, boolean validate) Sets the value of the TuningResolutionUnit attribute.
void	setTuningResolutionUnit(UnitsLength_Type value) Sets the value of the TuningResolutionUnit attribute.
UnitsLength_Type	getTuningResolutionUnit() Returns the value of the TuningResolutionUnit attribute.
void	resetTuningResolutionUnit() Resets the TuningResolutionUnit attribute to an unset state.
boolean	hasTuningResolutionUnit() Checks whether the optional TuningResolutionUnit attribute is present.
void	setTuningRate(float value, boolean validate) Sets the value of the TuningRate attribute.
void	setTuningRate(float value) Sets the value of the TuningRate attribute.
float	getTuningRate() Returns the value of the TuningRate attribute.
void	resetTuningRate() Resets the TuningRate attribute to an unset state.
boolean	hasTuningRate() Checks whether the TuningRate attribute is present.
void	setTuningRateUnit(UnitsTime_Type value, boolean validate) Sets the value of the TuningRateUnit attribute.
void	setTuningRateUnit(UnitsTime_Type value) Sets the value of the TuningRateUnit attribute.
UnitsTime_Type	getTuningRateUnit() Returns the value of the TuningRateUnit attribute.
void	resetTuningRateUnit() Resets the TuningRateUnit attribute to an unset state.
boolean	hasTuningRateUnit() Checks whether the optional TuningRateUnit attribute is present.
void	setAngleOfIncidence(float value, boolean validate) Sets the value of the AngleOfIncidence attribute.
void	setAngleOfIncidence(float value) Sets the value of the AngleOfIncidence attribute.
float	getAngleOfIncidence() Returns the value of the AngleOfIncidence attribute.
void	resetAngleOfIncidence() Resets the AngleOfIncidence attribute to an unset state.
boolean	hasAngleOfIncidence() Checks whether the AngleOfIncidence attribute is present.
void	setAngleOfIncidenceUnit(UnitsAngle_Type value, boolean validate) Sets the value of the AngleOfIncidenceUnit attribute.
void	setAngleOfIncidenceUnit(UnitsAngle_Type value) Sets the value of the AngleOfIncidenceUnit attribute.
UnitsAngle_Type	getAngleOfIncidenceUnit() Returns the value of the AngleOfIncidenceUnit attribute.
void	resetAngleOfIncidenceUnit() Resets the AngleOfIncidenceUnit attribute to an unset state.
boolean	hasAngleOfIncidenceUnit() Checks whether the optional AngleOfIncidenceUnit attribute is present.
void	setAngularAperture(float value, boolean validate) Sets the value of the AngularAperture attribute.
void	setAngularAperture(float value) Sets the value of the AngularAperture attribute.
float	getAngularAperture() Returns the value of the AngularAperture attribute.
void	resetAngularAperture() Resets the AngularAperture attribute to an unset state.
boolean	hasAngularAperture() Checks whether the AngularAperture attribute is present.
void	setAngularApertureUnit(UnitsAngle_Type value, boolean validate) Sets the value of the AngularApertureUnit attribute.
void	setAngularApertureUnit(UnitsAngle_Type value) Sets the value of the AngularApertureUnit attribute.
UnitsAngle_Type	getAngularApertureUnit() Returns the value of the AngularApertureUnit attribute.
void	resetAngularApertureUnit() Resets the AngularApertureUnit attribute to an unset state.
boolean	hasAngularApertureUnit() Checks whether the optional AngularApertureUnit attribute is present.
void	setMaterial(AODMaterial_Type value, boolean validate) Sets the value of the Material attribute.
void	setMaterial(AODMaterial_Type value) Sets the value of the Material attribute.
AODMaterial_Type	getMaterial() Returns the value of the Material attribute.
void	resetMaterial() Resets the Material attribute to an unset state.
boolean	hasMaterial() Checks whether the optional Material attribute is present.
void	setDesign(AODDesign_Type value, boolean validate) Sets the value of the Design attribute.
void	setDesign(AODDesign_Type value) Sets the value of the Design attribute.
AODDesign_Type	getDesign() Returns the value of the Design attribute.
void	resetDesign() Resets the Design attribute to an unset state.
boolean	hasDesign() Checks whether the optional Design attribute is present.
void	setGeometry(AODGeometry_Type value, boolean validate) Sets the value of the Geometry attribute.
void	setGeometry(AODGeometry_Type value) Sets the value of the Geometry attribute.
AODGeometry_Type	getGeometry() Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
boolean	hasGeometry() Checks whether the optional Geometry attribute is present.
void	setOperatingTemperature(float value, boolean validate) Sets the value of the OperatingTemperature attribute.
void	setOperatingTemperature(float value) Sets the value of the OperatingTemperature attribute.
float	getOperatingTemperature() Returns the value of the OperatingTemperature attribute.
void	resetOperatingTemperature() Resets the OperatingTemperature attribute to an unset state.
boolean	hasOperatingTemperature() Checks whether the OperatingTemperature attribute is present.
void	setOperatingTemperatureUnit(UnitsTemperature_Type value, boolean validate) Sets the value of the OperatingTemperatureUnit attribute.
void	setOperatingTemperatureUnit(UnitsTemperature_Type value) Sets the value of the OperatingTemperatureUnit attribute.
UnitsTemperature_Type	getOperatingTemperatureUnit() Returns the value of the OperatingTemperatureUnit attribute.
void	resetOperatingTemperatureUnit() Resets the OperatingTemperatureUnit attribute to an unset state.
boolean	hasOperatingTemperatureUnit() Checks whether the optional OperatingTemperatureUnit attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
AcoustoOpticalDevice_Type	__internal_create(long cPtr, boolean own)
AcoustoOpticalDevice_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a AcoustoOpticalDevice_Type.
StringSet	getCoatingAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
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	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
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.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_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.AcoustoOpticalDevice_Type;

Represents the XML complex type AcoustoOpticalDevice.

This is a device that performs spatial, temporal, and spectral modulations of light on the basis of acousto-optic (AO) diffraction. AO diffraction is a phenomenon whereby an acoustic wave propagating in an optically transparent medium, produces a periodic modulation of the index of refraction of the medium via the elasto-optical effect and might therefore diffract portions of an incident light into one or more directions.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.delete, com.inscoper.nbo.AcoustoOpticalDeflector.delete, com.inscoper.nbo.AcoustoOpticalModulator.delete, com.inscoper.nbo.AcoustoOpticalTuneableFilter.delete

function AcoustoOpticalDevice_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getTypeName

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.getTypeName, com.inscoper.nbo.AcoustoOpticalDeflector.getTypeName, com.inscoper.nbo.AcoustoOpticalModulator.getTypeName, com.inscoper.nbo.AcoustoOpticalTuneableFilter.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getXMLName

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.getXMLName, com.inscoper.nbo.AcoustoOpticalDeflector.getXMLName, com.inscoper.nbo.AcoustoOpticalModulator.getXMLName, com.inscoper.nbo.AcoustoOpticalTuneableFilter.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getNBOType

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.getNBOType, com.inscoper.nbo.AcoustoOpticalDeflector.getNBOType, com.inscoper.nbo.AcoustoOpticalModulator.getNBOType, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.getChildren

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.getChildren, com.inscoper.nbo.AcoustoOpticalDeflector.getChildren, com.inscoper.nbo.AcoustoOpticalModulator.getChildren, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.getSubElements

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.getSubElements, com.inscoper.nbo.AcoustoOpticalDeflector.getSubElements, com.inscoper.nbo.AcoustoOpticalModulator.getSubElements, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromJsonFile, com.inscoper.nbo.AcoustoOpticalDeflector.fromJsonFile, com.inscoper.nbo.AcoustoOpticalModulator.fromJsonFile, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromJsonFile, com.inscoper.nbo.AcoustoOpticalDeflector.fromJsonFile, com.inscoper.nbo.AcoustoOpticalModulator.fromJsonFile, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromJsonString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromJsonString, com.inscoper.nbo.AcoustoOpticalDeflector.fromJsonString, com.inscoper.nbo.AcoustoOpticalModulator.fromJsonString, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromJsonString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromJsonString, com.inscoper.nbo.AcoustoOpticalDeflector.fromJsonString, com.inscoper.nbo.AcoustoOpticalModulator.fromJsonString, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromXmlFile, com.inscoper.nbo.AcoustoOpticalDeflector.fromXmlFile, com.inscoper.nbo.AcoustoOpticalModulator.fromXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromXmlFile, com.inscoper.nbo.AcoustoOpticalDeflector.fromXmlFile, com.inscoper.nbo.AcoustoOpticalModulator.fromXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromXmlString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromXmlString, com.inscoper.nbo.AcoustoOpticalDeflector.fromXmlString, com.inscoper.nbo.AcoustoOpticalModulator.fromXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.fromXmlString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromXmlString, com.inscoper.nbo.AcoustoOpticalDeflector.fromXmlString, com.inscoper.nbo.AcoustoOpticalModulator.fromXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.toXmlFile, com.inscoper.nbo.AcoustoOpticalDeflector.toXmlFile, com.inscoper.nbo.AcoustoOpticalModulator.toXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.toXmlFile, com.inscoper.nbo.AcoustoOpticalDeflector.toXmlFile, com.inscoper.nbo.AcoustoOpticalModulator.toXmlFile, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.toXmlString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.toXmlString, com.inscoper.nbo.AcoustoOpticalDeflector.toXmlString, com.inscoper.nbo.AcoustoOpticalModulator.toXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.ManufacturerSpec_Type.toXmlString

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.toXmlString, com.inscoper.nbo.AcoustoOpticalDeflector.toXmlString, com.inscoper.nbo.AcoustoOpticalModulator.toXmlString, com.inscoper.nbo.AcoustoOpticalTuneableFilter.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.

A Unique Identifier for this component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

public void setName(
    Denomination_Type value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

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

A User-defined Name for this component.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setContrastRatio¶

public void setContrastRatio(
    PercentFraction_Type value,
    boolean validate
)

Sets the value of the ContrastRatio attribute.

Parameters:

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

This field records the reports on the ratio of maximum versus minimum transmittance.

function setContrastRatio¶

public void setContrastRatio(
    PercentFraction_Type value
)

Sets the value of the ContrastRatio attribute.

Parameters:

value The value to set

This field records the reports on the ratio of maximum versus minimum transmittance.

function getContrastRatio¶

public PercentFraction_Type getContrastRatio()

Returns the value of the ContrastRatio attribute.

Return: The value of the attribute

This field records the reports on the ratio of maximum versus minimum transmittance.

function resetContrastRatio¶

function hasContrastRatio¶

public boolean hasContrastRatio()

Checks whether the optional ContrastRatio attribute is present.

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

This field records the reports on the ratio of maximum versus minimum transmittance.

function setCoating¶

public void setCoating(
    String value,
    boolean validate
)

Sets the value of the Coating attribute.

Parameters:

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

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function setCoating¶

public void setCoating(
    String value
)

Sets the value of the Coating attribute.

Parameters:

value The value to set

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function getCoating¶

public String getCoating()

Returns the value of the Coating attribute.

Return: The value of the attribute

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function resetCoating¶

public void resetCoating()

Resets the Coating attribute to an unset state.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function hasCoating¶

public boolean hasCoating()

Checks whether the Coating attribute is present.

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

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

function setAttenuationMethod¶

public void setAttenuationMethod(
    AttenuationMethodType_Type 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 mean by which this optical element achieves out-of-band transmission attenuation.

function setAttenuationMethod¶

public void setAttenuationMethod(
    AttenuationMethodType_Type value
)

Sets the value of the AttenuationMethod attribute.

Parameters:

value The value to set

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function getAttenuationMethod¶

public AttenuationMethodType_Type getAttenuationMethod()

Returns the value of the AttenuationMethod attribute.

Return: The value of the attribute

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function resetAttenuationMethod¶

public void resetAttenuationMethod()

Resets the AttenuationMethod attribute to an unset state.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function hasAttenuationMethod¶

public boolean hasAttenuationMethod()

Checks whether the optional AttenuationMethod attribute is present.

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

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

function setAttenuationCoefficient¶

public void setAttenuationCoefficient(
    float value,
    boolean validate
)

Sets the value of the AttenuationCoefficient attribute.

Parameters:

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

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function setAttenuationCoefficient¶

public void setAttenuationCoefficient(
    float value
)

Sets the value of the AttenuationCoefficient attribute.

Parameters:

value The value to set

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function getAttenuationCoefficient¶

public float getAttenuationCoefficient()

Returns the value of the AttenuationCoefficient attribute.

Return: The value of the attribute

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function resetAttenuationCoefficient¶

public void resetAttenuationCoefficient()

Resets the AttenuationCoefficient attribute to an unset state.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function hasAttenuationCoefficient¶

public boolean hasAttenuationCoefficient()

Checks whether the AttenuationCoefficient attribute is present.

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

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD= -log10(T), and T=Transmittance (0≤T≤1).

function setTuningAccuracy¶

public void setTuningAccuracy(
    float value,
    boolean validate
)

Sets the value of the TuningAccuracy attribute.

Parameters:

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

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function setTuningAccuracy¶

public void setTuningAccuracy(
    float value
)

Sets the value of the TuningAccuracy attribute.

Parameters:

value The value to set

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function getTuningAccuracy¶

public float getTuningAccuracy()

Returns the value of the TuningAccuracy attribute.

Return: The value of the attribute

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function resetTuningAccuracy¶

public void resetTuningAccuracy()

Resets the TuningAccuracy attribute to an unset state.

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function hasTuningAccuracy¶

public boolean hasTuningAccuracy()

Checks whether the TuningAccuracy attribute is present.

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

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

function setTuningAccuracyUnit¶

public void setTuningAccuracyUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the TuningAccuracyUnit 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 setTuningAccuracyUnit¶

public void setTuningAccuracyUnit(
    UnitsLength_Type value
)

Sets the value of the TuningAccuracyUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTuningAccuracyUnit¶

function resetTuningAccuracyUnit¶

function hasTuningAccuracyUnit¶

public boolean hasTuningAccuracyUnit()

Checks whether the optional TuningAccuracyUnit attribute is present.

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

No description available in the XSD standard.

function setPolarization¶

public void setPolarization(
    PolarizationMode_Type value,
    boolean validate
)

Sets the value of the Polarization attribute.

Parameters:

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

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

function setPolarization¶

public void setPolarization(
    PolarizationMode_Type value
)

Sets the value of the Polarization attribute.

Parameters:

value The value to set

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

function getPolarization¶

public PolarizationMode_Type getPolarization()

Returns the value of the Polarization attribute.

Return: The value of the attribute

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

function resetPolarization¶

public void resetPolarization()

Resets the Polarization attribute to an unset state.

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

function hasPolarization¶

public boolean hasPolarization()

Checks whether the optional Polarization attribute is present.

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

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

function setBragg¶

public void setBragg(
    boolean value,
    boolean validate
)

Sets the value of the Bragg attribute.

Parameters:

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

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

function setBragg¶

public void setBragg(
    boolean value
)

Sets the value of the Bragg attribute.

Parameters:

value The value to set

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

function getBragg¶

public boolean getBragg()

Returns the value of the Bragg attribute.

Return: The value of the attribute

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

function resetBragg¶

public void resetBragg()

Resets the Bragg attribute to an unset state.

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

function hasBragg¶

public boolean hasBragg()

Checks whether the Bragg attribute is present.

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

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

function setTuningResolution¶

public void setTuningResolution(
    float value,
    boolean validate
)

Sets the value of the TuningResolution attribute.

Parameters:

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

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function setTuningResolution¶

public void setTuningResolution(
    float value
)

Sets the value of the TuningResolution attribute.

Parameters:

value The value to set

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function getTuningResolution¶

public float getTuningResolution()

Returns the value of the TuningResolution attribute.

Return: The value of the attribute

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function resetTuningResolution¶

public void resetTuningResolution()

Resets the TuningResolution attribute to an unset state.

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function hasTuningResolution¶

public boolean hasTuningResolution()

Checks whether the TuningResolution attribute is present.

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

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

function setTuningResolutionUnit¶

public void setTuningResolutionUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the TuningResolutionUnit 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 setTuningResolutionUnit¶

public void setTuningResolutionUnit(
    UnitsLength_Type value
)

Sets the value of the TuningResolutionUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTuningResolutionUnit¶

function resetTuningResolutionUnit¶

function hasTuningResolutionUnit¶

public boolean hasTuningResolutionUnit()

Checks whether the optional TuningResolutionUnit attribute is present.

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

No description available in the XSD standard.

function setTuningRate¶

public void setTuningRate(
    float value,
    boolean validate
)

Sets the value of the TuningRate attribute.

Parameters:

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

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function setTuningRate¶

public void setTuningRate(
    float value
)

Sets the value of the TuningRate attribute.

Parameters:

value The value to set

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function getTuningRate¶

public float getTuningRate()

Returns the value of the TuningRate attribute.

Return: The value of the attribute

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function resetTuningRate¶

public void resetTuningRate()

Resets the TuningRate attribute to an unset state.

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function hasTuningRate¶

public boolean hasTuningRate()

Checks whether the TuningRate attribute is present.

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

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

function setTuningRateUnit¶

public void setTuningRateUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the TuningRateUnit 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 setTuningRateUnit¶

function getTuningRateUnit¶

function resetTuningRateUnit¶

function hasTuningRateUnit¶

public boolean hasTuningRateUnit()

Checks whether the optional TuningRateUnit attribute is present.

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

No description available in the XSD standard.

function setAngleOfIncidence¶

public void setAngleOfIncidence(
    float value,
    boolean validate
)

Sets the value of the AngleOfIncidence attribute.

Parameters:

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

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function setAngleOfIncidence¶

public void setAngleOfIncidence(
    float value
)

Sets the value of the AngleOfIncidence attribute.

Parameters:

value The value to set

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function getAngleOfIncidence¶

public float getAngleOfIncidence()

Returns the value of the AngleOfIncidence attribute.

Return: The value of the attribute

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function resetAngleOfIncidence¶

public void resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function hasAngleOfIncidence¶

public boolean hasAngleOfIncidence()

Checks whether the AngleOfIncidence attribute is present.

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

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function setAngleOfIncidenceUnit¶

public void setAngleOfIncidenceUnit(
    UnitsAngle_Type value,
    boolean validate
)

Sets the value of the AngleOfIncidenceUnit 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 setAngleOfIncidenceUnit¶

public void setAngleOfIncidenceUnit(
    UnitsAngle_Type value
)

Sets the value of the AngleOfIncidenceUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAngleOfIncidenceUnit¶

function resetAngleOfIncidenceUnit¶

function hasAngleOfIncidenceUnit¶

public boolean hasAngleOfIncidenceUnit()

Checks whether the optional AngleOfIncidenceUnit attribute is present.

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

No description available in the XSD standard.

function setAngularAperture¶

public void setAngularAperture(
    float value,
    boolean validate
)

Sets the value of the AngularAperture attribute.

Parameters:

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

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function setAngularAperture¶

public void setAngularAperture(
    float value
)

Sets the value of the AngularAperture attribute.

Parameters:

value The value to set

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function getAngularAperture¶

public float getAngularAperture()

Returns the value of the AngularAperture attribute.

Return: The value of the attribute

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function resetAngularAperture¶

public void resetAngularAperture()

Resets the AngularAperture attribute to an unset state.

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function hasAngularAperture¶

public boolean hasAngularAperture()

Checks whether the AngularAperture attribute is present.

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

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

function setAngularApertureUnit¶

public void setAngularApertureUnit(
    UnitsAngle_Type value,
    boolean validate
)

Sets the value of the AngularApertureUnit 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 setAngularApertureUnit¶

public void setAngularApertureUnit(
    UnitsAngle_Type value
)

Sets the value of the AngularApertureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAngularApertureUnit¶

function resetAngularApertureUnit¶

function hasAngularApertureUnit¶

public boolean hasAngularApertureUnit()

Checks whether the optional AngularApertureUnit attribute is present.

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

No description available in the XSD standard.

function setMaterial¶

public void setMaterial(
    AODMaterial_Type value,
    boolean validate
)

Sets the value of the Material attribute.

Parameters:

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

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

function setMaterial¶

public void setMaterial(
    AODMaterial_Type value
)

Sets the value of the Material attribute.

Parameters:

value The value to set

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

function getMaterial¶

public AODMaterial_Type getMaterial()

Returns the value of the Material attribute.

Return: The value of the attribute

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

function resetMaterial¶

public void resetMaterial()

Resets the Material attribute to an unset state.

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

function hasMaterial¶

public boolean hasMaterial()

Checks whether the optional Material attribute is present.

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

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

function setDesign¶

public void setDesign(
    AODDesign_Type value,
    boolean validate
)

Sets the value of the Design attribute.

Parameters:

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

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

function setDesign¶

public void setDesign(
    AODDesign_Type value
)

Sets the value of the Design attribute.

Parameters:

value The value to set

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

function getDesign¶

public AODDesign_Type getDesign()

Returns the value of the Design attribute.

Return: The value of the attribute

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

function resetDesign¶

function hasDesign¶

public boolean hasDesign()

Checks whether the optional Design attribute is present.

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

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

function setGeometry¶

public void setGeometry(
    AODGeometry_Type value,
    boolean validate
)

Sets the value of the Geometry attribute.

Parameters:

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

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

function setGeometry¶

public void setGeometry(
    AODGeometry_Type value
)

Sets the value of the Geometry attribute.

Parameters:

value The value to set

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

function getGeometry¶

public AODGeometry_Type getGeometry()

Returns the value of the Geometry attribute.

Return: The value of the attribute

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

function resetGeometry¶

public void resetGeometry()

Resets the Geometry attribute to an unset state.

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

function hasGeometry¶

public boolean hasGeometry()

Checks whether the optional Geometry attribute is present.

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

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

function setOperatingTemperature¶

public void setOperatingTemperature(
    float value,
    boolean validate
)

Sets the value of the OperatingTemperature attribute.

Parameters:

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

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function setOperatingTemperature¶

public void setOperatingTemperature(
    float value
)

Sets the value of the OperatingTemperature attribute.

Parameters:

value The value to set

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function getOperatingTemperature¶

public float getOperatingTemperature()

Returns the value of the OperatingTemperature attribute.

Return: The value of the attribute

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function resetOperatingTemperature¶

public void resetOperatingTemperature()

Resets the OperatingTemperature attribute to an unset state.

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function hasOperatingTemperature¶

public boolean hasOperatingTemperature()

Checks whether the OperatingTemperature attribute is present.

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

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

function setOperatingTemperatureUnit¶

public void setOperatingTemperatureUnit(
    UnitsTemperature_Type value,
    boolean validate
)

Sets the value of the OperatingTemperatureUnit 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 setOperatingTemperatureUnit¶

public void setOperatingTemperatureUnit(
    UnitsTemperature_Type value
)

Sets the value of the OperatingTemperatureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getOperatingTemperatureUnit¶

public UnitsTemperature_Type getOperatingTemperatureUnit()

Returns the value of the OperatingTemperatureUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetOperatingTemperatureUnit¶

function hasOperatingTemperatureUnit¶

public boolean hasOperatingTemperatureUnit()

Checks whether the optional OperatingTemperatureUnit attribute is present.

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

No description available in the XSD standard.

function setAnnotationRef¶

public void setAnnotationRef(
    AnnotationRef value,
    boolean validate
)

Sets the value of the AnnotationRef element.

Parameters:

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

No description available in the XSD standard.

function setAnnotationRef¶

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

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

No description available in the XSD standard.

function __internal_create¶

public static AcoustoOpticalDevice_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.__internal_create, com.inscoper.nbo.AcoustoOpticalDeflector.__internal_create, com.inscoper.nbo.AcoustoOpticalModulator.__internal_create, com.inscoper.nbo.AcoustoOpticalTuneableFilter.__internal_create

function fromBase¶

public static AcoustoOpticalDevice_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a AcoustoOpticalDevice_Type.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromBase

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.fromBase, com.inscoper.nbo.AcoustoOpticalDeflector.fromBase, com.inscoper.nbo.AcoustoOpticalModulator.fromBase, com.inscoper.nbo.AcoustoOpticalTuneableFilter.fromBase

function getCoatingAllowedValues¶

public static StringSet getCoatingAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

Protected Functions Documentation¶

function AcoustoOpticalDevice_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.swigSetCMemOwn, com.inscoper.nbo.AcoustoOpticalDeflector.swigSetCMemOwn, com.inscoper.nbo.AcoustoOpticalModulator.swigSetCMemOwn, com.inscoper.nbo.AcoustoOpticalTuneableFilter.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

Reimplemented by: com.inscoper.nbo.AcoustoOpticalBeamSplitter.finalize, com.inscoper.nbo.AcoustoOpticalDeflector.finalize, com.inscoper.nbo.AcoustoOpticalModulator.finalize, com.inscoper.nbo.AcoustoOpticalTuneableFilter.finalize