Description This command retrieves the data length units specification from an Analysis Results Node. The data spatial units field is used when the data spatial units are different from the axes units, otherwise this field is "Unset".
Syntax dataSpatialUnits = ARNGetDataSpatialUnits( arnNode )
Parameters dataSpatialUnits (String) Returned string identifying the data spatial units. This value is typically "Unset" when the data spatial units match those of the axes units.
arnNode As Long Node identifier of the ARN whose data spatial units are being retrieved.
Example The following example calculates an irradiance spread function, retrieves and prints the value of the unmodified data spatial units, explicitly resets the data spatial units type, and then retrieves and prints the new data spatial units type for verification.
Sub Main
Dim anaNode As Long anaNode = FindFullName( "Analysis Surface(s).sourceAnalysis" )
EnableTextPrinting False ClearOutputWindow DeleteRays() ARNDeleteAllNodes() CreateSources()
Dim rayCnt As Long, arnNode As Long rayCnt = IrradianceToARN( anaNode, "Source Irradiance", arnNode )
Dim sUnits As String EnableTextPrinting True sUnits = ARNGetDataSpatialUnits( arnNode ) Print "Original data units are " & sUnits
sUnits = "mm" ARNSetDataSpatialUnits( arnNode, sUnits ) Print "Reset data spatial units to " & sUnits
sUnits = ARNGetDataSpatialUnits( arnNode ) Print "Retrieved modified data units are " & sUnits
End Sub
See Also
|