Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceIthWavelengthActive

 

GetSourceIthWavelengthActive

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the active flag for a specific wavelength entry on the given source node.

 

Syntax

flag = GetSourceIthWavelengthActive( nSource, nWave )

 

Parameters

flag (Boolean)

Wavelength status flag. Returns True for "active", False for inactive.

 

nSource as Long

Node number of source.

 

nWave as Long

Wavelength index value.

 

Remarks

Returns the active flag for a specific wavelength entry on the given source node.

 

Source wavelengths can now be individually made "active" or 'inactive".  No rays will be created at inactive wavelengths during source creation.  The power of rays created by the source will be adjusted to agree with the fractional power implied by the active wavelengths, i.e. the power associated with inactive wavelengths is removed.

 

See Also

SetSourceIthWavelengthActive

AddSourceWavelengthSpec

DeleteSourceIthWavelengthSpec

GetSourceIthWavelength

GetSourceIthWavelengthSpec

SetSourceIthWavelengthSpec

GetSourceWavelengthCount

 

 

 

 

 

Copyright © Photon Engineering, LLC