Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceSpectrum

 

GetSourceSpectrum

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the node number of the spectrum assigned to a source.  If the source does not have a spectrum assigned then the function returns -1.  If the source node being queried is invalid, an error is set and the operation is halted.

 

 

Syntax

spectNode = GetSourceSpectrum( srcNode )

 

 

Parameters

spectNode (Long)

Node number of the spectrum currently applied to the source.

 

srcNode As Long

Node number of the source being modified.

 

 

Remarks

The following example  finds the node for a source and then queries the source for the applied spectrum.

 

Dim srcNode As Long

Dim spectNode As Long

 

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

 

spectNode = GetSourceSpectrum( srcNode )

 

 

See Also

SetSourceSpectrum

SetSourcePowerUnits

GetSourcePowerUnits

SetSourceRayWavelengthMethod

GetSourceRayWavelengthMethod

SetSourceRayWavelengthRange

GetSourceRayWavelengthRange

 

 

 

 

 

Copyright © Photon Engineering, LLC