Description This function retrieves the configuration parameters from an Astigmatic Gaussian Beam type Source Primitive.
Syntax success = SourcePrimGetParmAstig( spNode, tAstig, wl )
Parameters success (Boolean) Returned boolean indicating whether the parameters were successfully retrieved from the source node.
spNode As Long Node number of the Astigmatic Gaussian Beam type Source Primitive being queried.
tAstig as T_SOURCEPRIMASTIG After the function executes, this data structure will be populated with the configuration parameters of the source.
wl As Double Retrieved source wavelength in units of microns.
Example The example below demonstrates how to query an Astigmatic Gaussian Beam type Source Primitive for its configuration parameters and report them to the output window.
Sub Main
'Source node being queried Dim spNode As Long spNode = FindFullName( "Optical Sources.DJ532" )
'Retrieve configuration parameters Dim success As Boolean Dim wl As Double Dim tAstig As T_SOURCEPRIMASTIG success = SourcePrimGetParmAstig( spNode, tAstig, wl )
'Report information Print "Astigmatic Gaussian Beam source configuration:" Print "Wavelength" & Chr(9) & wl & " microns" Print "Power (watts)" & Chr(9) & tAstig.PowerWatts Print "X angle" & Chr(9) & tAstig.semiAngX Print "Y angle" & Chr(9) & tAstig.semiAngY Print "X samples" & Chr(9) & tAstig.Xnum Print "Y samples" & Chr(9) & tAstig.Ynum Print "Z-Create" & Chr(9) & tAstig.Zcreate Print "Z-separation" & Chr(9) & tAstig.Zseparation Print ""
End Sub
See Also Source Primitive Script Commands
|