Navigation: Scripting Reference Manual > Functions & Subroutines > GetDiffractNoPhasePerLine

 

GetDiffractNoPhasePerLine

 

Contact Us: fredsupport@photonengr.com

 

Description

This command queries a grating surface to check whether the phase option "none" is toggled.

 

 

Syntax

boolFlag = GetDiffractNoPhasePerLine( gSurfNode )

 

 

Parameters

boolFlag (Boolean)

True or False return value indicating whether or not the grating is using the "none" phase addition option.

 

gSurfNode As Long

Node number of the grating surface.

 

 

Example

The following example queries a grating surface to see if the phase option "none" is toggled and sets this option if it is not already specified.

 

Sub Main

 

    'Surface node with the grating

    Dim gSurf As Long

    gSurf = FindFullName( "Geometry.Plane.Surface" )

 

    'Check if the grating surface uses the No Phase option.

    'If not, set the grating to use this option

    If Not GetDiffractNoPhasePerLine( gSurf ) Then

        'Specify the grating not to add additional OPL

        SetDiffractNoPhasePerLine( gSurf )

    End If

 

End Sub

 

See Also

Diffraction Grating Script Commands

Diffraction Gratings

 

 

 

 

 

Copyright © Photon Engineering, LLC