com.inscoper.nbo.Laser¶

Represents the XML element Laser. More...

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

Public Functions¶

	Name
synchronized void	delete()
	Laser()
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(LaserType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(LaserType_Type value) Sets the value of the Type attribute.
LaserType_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.
void	setTuneable(boolean value, boolean validate) Sets the value of the Tuneable attribute.
void	setTuneable(boolean value) Sets the value of the Tuneable attribute.
boolean	getTuneable() Returns the value of the Tuneable attribute.
void	resetTuneable() Resets the Tuneable attribute to an unset state.
boolean	hasTuneable() Checks whether the Tuneable attribute is present.
void	setModulationMechanism(LaserModulation_Type value, boolean validate) Sets the value of the ModulationMechanism attribute.
void	setModulationMechanism(LaserModulation_Type value) Sets the value of the ModulationMechanism attribute.
LaserModulation_Type	getModulationMechanism() Returns the value of the ModulationMechanism attribute.
void	resetModulationMechanism() Resets the ModulationMechanism attribute to an unset state.
boolean	hasModulationMechanism() Checks whether the optional ModulationMechanism attribute is present.
void	setPulse(boolean value, boolean validate) Sets the value of the Pulse attribute.
void	setPulse(boolean value) Sets the value of the Pulse attribute.
boolean	getPulse() Returns the value of the Pulse attribute.
void	resetPulse() Resets the Pulse attribute to an unset state.
boolean	hasPulse() Checks whether the Pulse attribute is present.
void	setLaserClass(LaserClass_Type value, boolean validate) Sets the value of the LaserClass attribute.
void	setLaserClass(LaserClass_Type value) Sets the value of the LaserClass attribute.
LaserClass_Type	getLaserClass() Returns the value of the LaserClass attribute.
void	resetLaserClass() Resets the LaserClass attribute to an unset state.
boolean	hasLaserClass() Checks whether the optional LaserClass attribute is present.
void	setLaserMedium(LaserMedium_Type value, boolean validate) Sets the value of the LaserMedium attribute.
void	setLaserMedium(LaserMedium_Type value) Sets the value of the LaserMedium attribute.
LaserMedium_Type	getLaserMedium() Returns the value of the LaserMedium attribute.
void	resetLaserMedium() Resets the LaserMedium attribute to an unset state.
boolean	hasLaserMedium() Checks whether the optional LaserMedium attribute is present.
void	setIsPumped(boolean value, boolean validate) Sets the value of the IsPumped attribute.
void	setIsPumped(boolean value) Sets the value of the IsPumped attribute.
boolean	getIsPumped() Returns the value of the IsPumped attribute.
void	resetIsPumped() Resets the IsPumped attribute to an unset state.
boolean	hasIsPumped() Checks whether the IsPumped attribute is present.
void	setIsPump(boolean value, boolean validate) Sets the value of the IsPump attribute.
void	setIsPump(boolean value) Sets the value of the IsPump attribute.
boolean	getIsPump() Returns the value of the IsPump attribute.
void	resetIsPump() Resets the IsPump attribute to an unset state.
boolean	hasIsPump() Checks whether the IsPump attribute is present.
void	setPosition(long value, boolean validate) Sets the value of the Position attribute.
void	setPosition(long value) Sets the value of the Position attribute.
long	getPosition() Returns the value of the Position attribute.
void	resetPosition() Resets the Position attribute to an unset state.
boolean	hasPosition() Checks whether the Position attribute is present.
void	setRepetitionRate(float value, boolean validate) Sets the value of the RepetitionRate attribute.
void	setRepetitionRate(float value) Sets the value of the RepetitionRate attribute.
float	getRepetitionRate() Returns the value of the RepetitionRate attribute.
void	resetRepetitionRate() Resets the RepetitionRate attribute to an unset state.
boolean	hasRepetitionRate() Checks whether the RepetitionRate attribute is present.
void	setRepetitionRateUnit(UnitsFrequency_Type value, boolean validate) Sets the value of the RepetitionRateUnit attribute.
void	setRepetitionRateUnit(UnitsFrequency_Type value) Sets the value of the RepetitionRateUnit attribute.
UnitsFrequency_Type	getRepetitionRateUnit() Returns the value of the RepetitionRateUnit attribute.
void	resetRepetitionRateUnit() Resets the RepetitionRateUnit attribute to an unset state.
boolean	hasRepetitionRateUnit() Checks whether the optional RepetitionRateUnit attribute is present.
void	setPulseDuration(float value, boolean validate) Sets the value of the PulseDuration attribute.
void	setPulseDuration(float value) Sets the value of the PulseDuration attribute.
float	getPulseDuration() Returns the value of the PulseDuration attribute.
void	resetPulseDuration() Resets the PulseDuration attribute to an unset state.
boolean	hasPulseDuration() Checks whether the PulseDuration attribute is present.
void	setPulseDurationUnit(UnitsTime_Type value, boolean validate) Sets the value of the PulseDurationUnit attribute.
void	setPulseDurationUnit(UnitsTime_Type value) Sets the value of the PulseDurationUnit attribute.
UnitsTime_Type	getPulseDurationUnit() Returns the value of the PulseDurationUnit attribute.
void	resetPulseDurationUnit() Resets the PulseDurationUnit attribute to an unset state.
boolean	hasPulseDurationUnit() Checks whether the optional PulseDurationUnit attribute is present.
void	setFrequencyMultiplication(float value, boolean validate) Sets the value of the FrequencyMultiplication attribute.
void	setFrequencyMultiplication(float value) Sets the value of the FrequencyMultiplication attribute.
float	getFrequencyMultiplication() Returns the value of the FrequencyMultiplication attribute.
void	resetFrequencyMultiplication() Resets the FrequencyMultiplication attribute to an unset state.
boolean	hasFrequencyMultiplication() Checks whether the FrequencyMultiplication attribute is present.
void	setUsedAcoustoOpticalDevice(boolean value, boolean validate) Sets the value of the UsedAcoustoOpticalDevice attribute.
void	setUsedAcoustoOpticalDevice(boolean value) Sets the value of the UsedAcoustoOpticalDevice attribute.
boolean	getUsedAcoustoOpticalDevice() Returns the value of the UsedAcoustoOpticalDevice attribute.
void	resetUsedAcoustoOpticalDevice() Resets the UsedAcoustoOpticalDevice attribute to an unset state.
boolean	hasUsedAcoustoOpticalDevice() Checks whether the UsedAcoustoOpticalDevice attribute is present.
void	setIlluminationWavelengthRange_List(IlluminationWavelengthRangeVector value, boolean validate) Sets the list of IlluminationWavelengthRange elements.
void	setIlluminationWavelengthRange_List(IlluminationWavelengthRangeVector value) Sets the list of IlluminationWavelengthRange elements.
IlluminationWavelengthRangeVector	getIlluminationWavelengthRange_List() Returns the list of IlluminationWavelengthRange elements.
void	addToIlluminationWavelengthRange_List(IlluminationWavelengthRange value, boolean validate) Adds a new IlluminationWavelengthRange element to this object.
void	addToIlluminationWavelengthRange_List(IlluminationWavelengthRange value) Adds a new IlluminationWavelengthRange element to this object.
void	clearIlluminationWavelengthRange_List() Clear the list of IlluminationWavelengthRange.
void	setAcoustoOpticalDeviceRef_List(AcoustoOpticalDeviceRefVector value, boolean validate) Sets the list of AcoustoOpticalDeviceRef elements.
void	setAcoustoOpticalDeviceRef_List(AcoustoOpticalDeviceRefVector value) Sets the list of AcoustoOpticalDeviceRef elements.
AcoustoOpticalDeviceRefVector	getAcoustoOpticalDeviceRef_List() Returns the list of AcoustoOpticalDeviceRef elements.
void	addToAcoustoOpticalDeviceRef_List(AcoustoOpticalDeviceRef value, boolean validate) Adds a new AcoustoOpticalDeviceRef element to this object.
void	addToAcoustoOpticalDeviceRef_List(AcoustoOpticalDeviceRef value) Adds a new AcoustoOpticalDeviceRef element to this object.
void	clearAcoustoOpticalDeviceRef_List() Clear the list of AcoustoOpticalDeviceRef.
void	setPump(Pump value, boolean validate) Sets the value of the Pump element.
void	setPump(Pump value) Sets the value of the Pump element.
Pump	getPump() Returns the value of the Pump element.
void	resetPump() Resets the Pump element to an unset state.
boolean	hasPump() Checks whether the optional Pump element is present.
Laser	__internal_create(long cPtr, boolean own)
Laser	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Laser.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.LightSource_Type

	Name
	LightSource_Type()
void	setID(LightSourceID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LightSourceID_Type value) Sets the value of the ID attribute.
LightSourceID_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	setPurchaseDate(String value, boolean validate) Sets the value of the PurchaseDate attribute.
void	setPurchaseDate(String value) Sets the value of the PurchaseDate attribute.
String	getPurchaseDate() Returns the value of the PurchaseDate attribute.
void	resetPurchaseDate() Resets the PurchaseDate attribute to an unset state.
boolean	hasPurchaseDate() Checks whether the PurchaseDate attribute is present.
void	setIlluminationPowerReportingStatistic(LightSourceIlluminationPowerReportingStatistic_Type value, boolean validate) Sets the value of the IlluminationPowerReportingStatistic attribute.
void	setIlluminationPowerReportingStatistic(LightSourceIlluminationPowerReportingStatistic_Type value) Sets the value of the IlluminationPowerReportingStatistic attribute.
LightSourceIlluminationPowerReportingStatistic_Type	getIlluminationPowerReportingStatistic() Returns the value of the IlluminationPowerReportingStatistic attribute.
void	resetIlluminationPowerReportingStatistic() Resets the IlluminationPowerReportingStatistic attribute to an unset state.
boolean	hasIlluminationPowerReportingStatistic() Checks whether the optional IlluminationPowerReportingStatistic attribute is present.
void	setIlluminationPowerReportingPosition(LightSourceIlluminationPowerReportingPosition_Type value, boolean validate) Sets the value of the IlluminationPowerReportingPosition attribute.
void	setIlluminationPowerReportingPosition(LightSourceIlluminationPowerReportingPosition_Type value) Sets the value of the IlluminationPowerReportingPosition attribute.
LightSourceIlluminationPowerReportingPosition_Type	getIlluminationPowerReportingPosition() Returns the value of the IlluminationPowerReportingPosition attribute.
void	resetIlluminationPowerReportingPosition() Resets the IlluminationPowerReportingPosition attribute to an unset state.
boolean	hasIlluminationPowerReportingPosition() Checks whether the optional IlluminationPowerReportingPosition 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	getPurchaseDateAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.LightSource_Type

	Name
	LightSource_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.Laser;

Represents the XML element Laser.

This element describes a Light Source, which emits coherent radiation at high spectral concentrations of radiance and minimal solid angles. This includes proper Light Amplification by Stimulated Emission of Radiation (LASER) sources that emit light through a process of optical amplification based on the stimulated emission of electromagnetic radiation. It also includes Optical Parametric Oscillator (OPO) sources that use a kind of LASER resonator but based on optical gain from parametric amplification in a nonlinear crystal rather than from stimulated emission.

Public Functions Documentation¶

function delete¶

function Laser¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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.LightSource_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.LightSource_Type.fromJsonFile

function 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.LightSource_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.LightSource_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.LightSource_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.LightSource_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.LightSource_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.LightSource_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.LightSource_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.LightSource_Type.toXmlString

function toXmlString¶

function setType¶

public void setType(
    LaserType_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 captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function setType¶

public void setType(
    LaserType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function getType¶

public LaserType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function resetType¶

public void resetType()

Resets the Type attribute to an unset state.

This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

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 captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.

function setTuneable¶

public void setTuneable(
    boolean value,
    boolean validate
)

Sets the value of the Tuneable attribute.

Parameters:

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

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function setTuneable¶

public void setTuneable(
    boolean value
)

Sets the value of the Tuneable attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function getTuneable¶

public boolean getTuneable()

Returns the value of the Tuneable attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function resetTuneable¶

function hasTuneable¶

public boolean hasTuneable()

Checks whether the Tuneable attribute is present.

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

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

function setModulationMechanism¶

public void setModulationMechanism(
    LaserModulation_Type value,
    boolean validate
)

Sets the value of the ModulationMechanism attribute.

Parameters:

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

This field captures the Modulation Mechanism used for this Laser.

function setModulationMechanism¶

public void setModulationMechanism(
    LaserModulation_Type value
)

Sets the value of the ModulationMechanism attribute.

Parameters:

value The value to set

This field captures the Modulation Mechanism used for this Laser.

function getModulationMechanism¶

public LaserModulation_Type getModulationMechanism()

Returns the value of the ModulationMechanism attribute.

Return: The value of the attribute

This field captures the Modulation Mechanism used for this Laser.

function resetModulationMechanism¶

function hasModulationMechanism¶

public boolean hasModulationMechanism()

Checks whether the optional ModulationMechanism attribute is present.

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

This field captures the Modulation Mechanism used for this Laser.

function setPulse¶

public void setPulse(
    boolean value,
    boolean validate
)

Sets the value of the Pulse attribute.

Parameters:

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

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function setPulse¶

public void setPulse(
    boolean value
)

Sets the value of the Pulse attribute.

Parameters:

value The value to set

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function getPulse¶

public boolean getPulse()

Returns the value of the Pulse attribute.

Return: The value of the attribute

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function resetPulse¶

public void resetPulse()

Resets the Pulse attribute to an unset state.

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function hasPulse¶

public boolean hasPulse()

Checks whether the Pulse attribute is present.

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

Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).

function setLaserClass¶

public void setLaserClass(
    LaserClass_Type value,
    boolean validate
)

Sets the value of the LaserClass attribute.

Parameters:

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

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function setLaserClass¶

public void setLaserClass(
    LaserClass_Type value
)

Sets the value of the LaserClass attribute.

Parameters:

value The value to set

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function getLaserClass¶

public LaserClass_Type getLaserClass()

Returns the value of the LaserClass attribute.

Return: The value of the attribute

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function resetLaserClass¶

public void resetLaserClass()

Resets the LaserClass attribute to an unset state.

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function hasLaserClass¶

public boolean hasLaserClass()

Checks whether the optional LaserClass attribute is present.

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

This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.

function setLaserMedium¶

public void setLaserMedium(
    LaserMedium_Type value,
    boolean validate
)

Sets the value of the LaserMedium attribute.

Parameters:

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

This field captures the material out of which this Laser is constructed.

function setLaserMedium¶

public void setLaserMedium(
    LaserMedium_Type value
)

Sets the value of the LaserMedium attribute.

Parameters:

value The value to set

This field captures the material out of which this Laser is constructed.

function getLaserMedium¶

public LaserMedium_Type getLaserMedium()

Returns the value of the LaserMedium attribute.

Return: The value of the attribute

This field captures the material out of which this Laser is constructed.

function resetLaserMedium¶

function hasLaserMedium¶

public boolean hasLaserMedium()

Checks whether the optional LaserMedium attribute is present.

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

This field captures the material out of which this Laser is constructed.

function setIsPumped¶

public void setIsPumped(
    boolean value,
    boolean validate
)

Sets the value of the IsPumped attribute.

Parameters:

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

Whether (True) or not (False) this is a pumped Laser.

function setIsPumped¶

function getIsPumped¶

function resetIsPumped¶

function hasIsPumped¶

function setIsPump¶

public void setIsPump(
    boolean value,
    boolean validate
)

Sets the value of the IsPump attribute.

Parameters:

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

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

function setIsPump¶

public void setIsPump(
    boolean value
)

Sets the value of the IsPump attribute.

Parameters:

value The value to set

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

function getIsPump¶

function resetIsPump¶

function hasIsPump¶

public boolean hasIsPump()

Checks whether the IsPump attribute is present.

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

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

function setPosition¶

public void setPosition(
    long value,
    boolean validate
)

Sets the value of the Position attribute.

Parameters:

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

This field captures the position of this Laser on a Multi Laser Engine.

function setPosition¶

function getPosition¶

function resetPosition¶

function hasPosition¶

public boolean hasPosition()

Checks whether the Position attribute is present.

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

This field captures the position of this Laser on a Multi Laser Engine.

function setRepetitionRate¶

public void setRepetitionRate(
    float value,
    boolean validate
)

Sets the value of the RepetitionRate attribute.

Parameters:

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

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function setRepetitionRate¶

public void setRepetitionRate(
    float value
)

Sets the value of the RepetitionRate attribute.

Parameters:

value The value to set

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function getRepetitionRate¶

public float getRepetitionRate()

Returns the value of the RepetitionRate attribute.

Return: The value of the attribute

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function resetRepetitionRate¶

public void resetRepetitionRate()

Resets the RepetitionRate attribute to an unset state.

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function hasRepetitionRate¶

public boolean hasRepetitionRate()

Checks whether the RepetitionRate attribute is present.

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

In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.

function setRepetitionRateUnit¶

public void setRepetitionRateUnit(
    UnitsFrequency_Type value,
    boolean validate
)

Sets the value of the RepetitionRateUnit 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 setRepetitionRateUnit¶

public void setRepetitionRateUnit(
    UnitsFrequency_Type value
)

Sets the value of the RepetitionRateUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getRepetitionRateUnit¶

function resetRepetitionRateUnit¶

function hasRepetitionRateUnit¶

public boolean hasRepetitionRateUnit()

Checks whether the optional RepetitionRateUnit attribute is present.

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

No description available in the XSD standard.

function setPulseDuration¶

public void setPulseDuration(
    float value,
    boolean validate
)

Sets the value of the PulseDuration attribute.

Parameters:

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

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function setPulseDuration¶

public void setPulseDuration(
    float value
)

Sets the value of the PulseDuration attribute.

Parameters:

value The value to set

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function getPulseDuration¶

public float getPulseDuration()

Returns the value of the PulseDuration attribute.

Return: The value of the attribute

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function resetPulseDuration¶

function hasPulseDuration¶

public boolean hasPulseDuration()

Checks whether the PulseDuration attribute is present.

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

In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.

function setPulseDurationUnit¶

public void setPulseDurationUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the PulseDurationUnit 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 setPulseDurationUnit¶

function getPulseDurationUnit¶

function resetPulseDurationUnit¶

function hasPulseDurationUnit¶

public boolean hasPulseDurationUnit()

Checks whether the optional PulseDurationUnit attribute is present.

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

No description available in the XSD standard.

function setFrequencyMultiplication¶

public void setFrequencyMultiplication(
    float value,
    boolean validate
)

Sets the value of the FrequencyMultiplication attribute.

Parameters:

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

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function setFrequencyMultiplication¶

public void setFrequencyMultiplication(
    float value
)

Sets the value of the FrequencyMultiplication attribute.

Parameters:

value The value to set

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function getFrequencyMultiplication¶

public float getFrequencyMultiplication()

Returns the value of the FrequencyMultiplication attribute.

Return: The value of the attribute

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function resetFrequencyMultiplication¶

public void resetFrequencyMultiplication()

Resets the FrequencyMultiplication attribute to an unset state.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function hasFrequencyMultiplication¶

public boolean hasFrequencyMultiplication()

Checks whether the FrequencyMultiplication attribute is present.

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

This field captures the optical frequency multiplication factor that may be specified for this Laser.

function setUsedAcoustoOpticalDevice¶

public void setUsedAcoustoOpticalDevice(
    boolean value,
    boolean validate
)

Sets the value of the UsedAcoustoOpticalDevice attribute.

Parameters:

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

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function setUsedAcoustoOpticalDevice¶

public void setUsedAcoustoOpticalDevice(
    boolean value
)

Sets the value of the UsedAcoustoOpticalDevice attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function getUsedAcoustoOpticalDevice¶

public boolean getUsedAcoustoOpticalDevice()

Returns the value of the UsedAcoustoOpticalDevice attribute.

Return: The value of the attribute

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function resetUsedAcoustoOpticalDevice¶

public void resetUsedAcoustoOpticalDevice()

Resets the UsedAcoustoOpticalDevice attribute to an unset state.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function hasUsedAcoustoOpticalDevice¶

public boolean hasUsedAcoustoOpticalDevice()

Checks whether the UsedAcoustoOpticalDevice attribute is present.

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

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

function setIlluminationWavelengthRange_List¶

public void setIlluminationWavelengthRange_List(
    IlluminationWavelengthRangeVector value,
    boolean validate
)

Sets the list of IlluminationWavelengthRange elements.

Parameters:

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

No description available in the XSD standard.

function setIlluminationWavelengthRange_List¶

public void setIlluminationWavelengthRange_List(
    IlluminationWavelengthRangeVector value
)

Sets the list of IlluminationWavelengthRange elements.

Parameters:

value The new list of IlluminationWavelengthRange elements

No description available in the XSD standard.

function getIlluminationWavelengthRange_List¶

public IlluminationWavelengthRangeVector getIlluminationWavelengthRange_List()

Returns the list of IlluminationWavelengthRange elements.

Return: The list of IlluminationWavelengthRange elements

No description available in the XSD standard.

function addToIlluminationWavelengthRange_List¶

public void addToIlluminationWavelengthRange_List(
    IlluminationWavelengthRange value,
    boolean validate
)

Adds a new IlluminationWavelengthRange 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 addToIlluminationWavelengthRange_List¶

public void addToIlluminationWavelengthRange_List(
    IlluminationWavelengthRange value
)

Adds a new IlluminationWavelengthRange element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearIlluminationWavelengthRange_List¶

function setAcoustoOpticalDeviceRef_List¶

public void setAcoustoOpticalDeviceRef_List(
    AcoustoOpticalDeviceRefVector value,
    boolean validate
)

Sets the list of AcoustoOpticalDeviceRef elements.

Parameters:

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

No description available in the XSD standard.

function setAcoustoOpticalDeviceRef_List¶

public void setAcoustoOpticalDeviceRef_List(
    AcoustoOpticalDeviceRefVector value
)

Sets the list of AcoustoOpticalDeviceRef elements.

Parameters:

value The new list of AcoustoOpticalDeviceRef elements

No description available in the XSD standard.

function getAcoustoOpticalDeviceRef_List¶

public AcoustoOpticalDeviceRefVector getAcoustoOpticalDeviceRef_List()

Returns the list of AcoustoOpticalDeviceRef elements.

Return: The list of AcoustoOpticalDeviceRef elements

No description available in the XSD standard.

function addToAcoustoOpticalDeviceRef_List¶

public void addToAcoustoOpticalDeviceRef_List(
    AcoustoOpticalDeviceRef value,
    boolean validate
)

Adds a new AcoustoOpticalDeviceRef 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 addToAcoustoOpticalDeviceRef_List¶

public void addToAcoustoOpticalDeviceRef_List(
    AcoustoOpticalDeviceRef value
)

Adds a new AcoustoOpticalDeviceRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAcoustoOpticalDeviceRef_List¶

function setPump¶

public void setPump(
    Pump value,
    boolean validate
)

Sets the value of the Pump 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 setPump¶

function getPump¶

function resetPump¶

function hasPump¶

function __internal_create¶

function fromBase¶

public static Laser fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a Laser.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.LightSource_Type.fromBase