Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceRayWavelengthMethod

 

GetSourceRayWavelengthMethod

 

Contact Us: fredsupport@photonengr.com

 

Description

Gets the source ray wavelength generation method.  The method is indicated by a Long, where 0 = "As specified by list" and 1 = "Randomly according to spectrum".

 

 

Syntax

method = GetSourceRayWavelengthMethod( srcNode )

 

 

Parameters

method (Long)

Value indicating the method to be used in generating ray wavelengths for the source.  Valid options are:

0: "As specified by list"

1: "Randomly according to spectrum"

 

srcNode As Long

Node number of the source being modified.

 

 

Remarks

The following example finds a source node, gets the wavelength generation method and prints the value.

 

Dim srcNode As Long

Dim method As Long

 

srcNode = FindFullName( "Optical Sources.Source 1" )

method = GetSourceRayWavelengthMethod( srcNode )

 

Print "Ray wavelength method is: " & method

 

 

See Also

SetSourceSpectrum

GetSourceSpectrum

SetSourcePowerUnits

GetSourcePowerUnits

SetSourceRayWavelengthMethod

SetSourceRayWavelengthRange

GetSourceRayWavelengthRange

 

 

 

 

 

Copyright © Photon Engineering, LLC