Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourcePowerUnits

 

GetSourcePowerUnits

 

Contact Us: fredsupport@photonengr.com

 

Description

Gets the power units for a given source node.  Units are indicated by a value of type Long, where 0 = Unspecified units, 1 = Watts and 2 = Lumens.

 

 

Syntax

pwrUnits = GetSourcePowerUnits( srcNode )

 

 

Parameters

pwrUnits (Long)

Value indicating power units currently applied.  Valid options are:

0: Unspecified Units

1: Watts

2: Lumens (Source must also have a spectrum applied)

 

srcNode As Long

Node number of the source being queried.

 

 

 

 

Remarks

The following example  finds the node for a source and then gets the source power units specification.

 

Dim srcNode As Long

Dim pwrUnits As Long

 

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

pwrUnits = getSourcePowerUnits( srcNode )

 

 

See Also

SetSourceSpectrum

GetSourceSpectrum

SetSourcePowerUnits

SetSourceRayWavelengthMethod

GetSourceRayWavelengthMethod

SetSourceRayWavelengthRange

GetSourceRayWavelengthRange

 

 

 

 

 

Copyright © Photon Engineering, LLC