Description

This function retrieves the configuration parameters from a Laser Diode Beam or M-Squared Laser Beam type Source Primitive.  A boolean is returned indicating whether the parameters were successfully retrieved.

Syntax

success = SourcePrimGetParmLaser( spNode, tLaser, wl )

Parameters

success (Boolean)

Returned boolean indicating whether the parameters were successfully retrieved from the source node.

spNode As Long

Node number of the Laser Diode Beam or M-Squared Laser Beam type Source Primitive being queried.

tLaser as T_SOURCEPRIMLASER

After the function executes, this data structure will containing the configuration parameters of the source.

wl As Double

Returned source wavelength in microns.

Example

Laser Diode Beam

M-Squared Laser Beam

Laser Diode Beam

The example below demonstrates how retrieve the configuration parameters from a Laser Diode Beam type Source Primitive.

Sub Main

    'Source primitive to be queried

    Dim spNode As Long

    spNode = FindFullName( "Optical Sources.Laser Diode" )

    'Retrieve the configuration parameters

    Dim success As Boolean

    Dim wl As Double

    Dim tLaser As T_SOURCEPRIMLASER

    success = SourcePrimGetParmLaser( spNode, tLaser, wl )

    'Report information

    Print "Wavelength" & Chr(9) & wl & " microns"

    Print "Angle type" & Chr(9) & tLaser.angType

    Print "X astig" & Chr(9) & tLaser.ParamX

    Print "Y astig" & Chr(9) & tLaser.ParamY

    Print "Power (watts)" & Chr(9) & tLaser.PowerWatts

    Print "Angle_X" & Chr(9) & tLaser.semiAngX

    Print "Angle_Y" & Chr(9) & tLaser.semiAngY

    Print "Samples X" & Chr(9) & tLaser.Xnum

    Print "Samples Y" & Chr(9) & tLaser.Ynum

End Sub

M-Squared Laser Beam

The example below demonstrates how to retrieve the configuration parameters from an M-Squared Laser Beam type Source Primitive.

Sub Main

    'Source primitive to be queried

    Dim spNode As Long

    spNode = FindFullName( "Optical Sources.M2 Beam" )

    'Retrieve the configuration parameters

    Dim success As Boolean

    Dim wl As Double

    Dim tLaser As T_SOURCEPRIMLASER

    success = SourcePrimGetParmLaser( spNode, tLaser, wl )

    'Report information

    Print "Wavelength" & Chr(9) & wl

    Print "Angle type" & Chr(9) & tLaser.angType

    Print "M2_x" & Chr(9) & tLaser.ParamX

    Print "M2_y" & Chr(9) & tLaser.ParamY

    Print "Power (watts)" & Chr(9) & tLaser.PowerWatts

    Print "Angle_X" & Chr(9) & tLaser.semiAngX

    Print "Angle_Y" & Chr(9) & tLaser.semiAngY

    Print "Samples X" & Chr(9) & tLaser.Xnum

    Print "Samples Y" & Chr(9) & tLaser.Ynum

End Sub

See Also

Source Primitive Script Commands

Laser Diode Beam

M-Squared Laser Beam

SourcePrimSetParmLaser

T_SOURCEPRIMLASER