Navigation: Scripting Reference Manual > Functions & Subroutines > DEGetIthOp

 

DEGetIthOp

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves a ray filter operation from a detector entity.

 

 

Syntax

success = DEGetIthOp( deNode, opInd, rfOp )

 

 

Parameters

success (Boolean)

Returned True or False indicating the success of the operation retrieval.

 

deNode As Long

Node number of the detector entity whose ray filter operation is being retrieved.

 

opInd As Long

Zero-based index of the operation being retrieved from the detector entity's ray filter operation list.

 

rfOp As T_RAYFILTEROP

Structure containing the ray filter operation information being added to the detector entity.

 

 

Example

The following example demonstrates the use of the ray filter operation commands as they relate to detector entities.  In this example the operation count for a detector entity is retrieved and the operation at index 0 is retrieved and modified before the analysis is performed.

 

Sub Main

 

          Dim rfOp As T_RAYFILTEROP

          Dim deNode As Long, opCount As Long, cnt As Long, arnNode As Long

          Dim success As Boolean

 

          deNode = FindFullName( "Analysis Surface(s).Cylinder Detector Entity" )

 

          opCount = DEGetOpCount( deNode )

          Print "Detector entity " & deNode & " has " & opCount & " ray filter operations."

 

          'Get, modify, and set the 0'th operation in the list

          success = DEGetIthOp( deNode, 0, rfOp )

          rfOp.opCode = 23 'scattered rays

          DESetIthOp deNode, 0, rfOp

 

          'Perform analysis with modified ray filter

          cnt = DEPerformAnalysis( deNode )

 

          Print "Detector entity analysis results stored in ARN " & DEGetMostRecentARNNum( deNode )

 

End Sub

 

See Also

DEAddOp

DECreate

DEDeleteIthOp

DEGetMostRecentARNNum

DEGetOpCount

DEGetParam

DEGetParamNames

DEGetParams

DEGetType

DEPerformAnalysis

DESetIthOp

DESetParam

DESetParams

IsDetectorEntity

 

 

 

 

 

Copyright © Photon Engineering, LLC