com.inscoper.nbo.AcoustoOpticalModulator¶

Represents the XML element AcoustoOpticalModulator. More...

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

Public Functions¶

	Name
synchronized void	delete()
	AcoustoOpticalModulator()
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	setType(AOMType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(AOMType_Type value) Sets the value of the Type attribute.
AOMType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
AcoustoOpticalModulator	__internal_create(long cPtr, boolean own)
AcoustoOpticalModulator	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a AcoustoOpticalModulator.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.AcoustoOpticalDevice_Type

	Name
	AcoustoOpticalDevice_Type()
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.
StringSet	getCoatingAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.AcoustoOpticalDevice_Type

	Name
	AcoustoOpticalDevice_Type(long cPtr, boolean cMemoryOwn)

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.AcoustoOpticalModulator;

Represents the XML element AcoustoOpticalModulator.

An acousto-optic modulator (AOM) is an electronically-tunable device which can be used for controlling the direction and/or intensity of a laser beam by an acoustically-induced diffraction grating in a crystal. It is based on the acousto-optic effect, i.e. the modification of the refractive index of some crystal or glass material by the oscillating mechanical strain of a sound wave (photoelastic effect).

Public Functions Documentation¶

function delete¶

function AcoustoOpticalModulator¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromXmlFile

function fromXmlFile¶

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.toXmlString

function setType¶

public void setType(
    AOMType_Type value,
    boolean validate
)

Sets the value of the Type attribute.

Parameters:

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

This field describes the category of this device.

function setType¶

function getType¶

function resetType¶

function hasType¶

public boolean hasType()

Checks whether the optional Type attribute is present.

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

This field describes the category of this device.

function __internal_create¶

function fromBase¶

public static AcoustoOpticalModulator fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a AcoustoOpticalModulator.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.AcoustoOpticalDevice_Type.fromBase

com.inscoper.nbo.AcoustoOpticalModulator¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function AcoustoOpticalModulator¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setType¶

function setType¶

function getType¶

function resetType¶

function hasType¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function AcoustoOpticalModulator¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶