Navigation: Scripting Reference Manual > Data Structures > T_CONFIGURATION

 

T_CONFIGURATION

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure used for retrieving and modifying configuration variable data. 

 

 

Definition

T_CONFIGURATION

description As String

entity As Long

type As String

index As Long

subindex As Long

values() As Double

 

 

Members

description

String description of the configuration variable.

 

entity

Index of the entity to which the variable value corresponds.

 

type

String indicating the variable type.  Please see the Optimization Variables help topic for a listing of the available variable types.  Valid strings match those provided in the variable type drop down list of the configuration dialog.

 

index

Contains the array index for configuration variable types with multiple entries (ex. Position/Orientation).  If the configuration variable does not need an index value, -1 is used. See Optimization Variables for index/sub-index specification.

 

subindex

Contains the array sub-index for configuration variable types with multiple entries (ex. Position/Orientation).  If the configuration variable does not need an index value, -1 is used. See Optimization Variables for index/sub-index specification.

 

values()

Array of doubles containing the value of the variable for each configuration.  For example, if there are three configurations, then there are three variable values and the values() array has maximum index 2 (0 based array).

 

 

Example

The following script loops over all configuration variables and prints their definitions to the output window.

 

Sub Main

 

    ClearOutputWindow()

 

    Dim tConfigVar As T_CONFIGURATION

    Dim curVariable As Long, curConfig As Long

    For curVariable = 0 To GetConfigVariableCount()-1

        GetConfigVariable curVariable, tConfigVar

        Print "Configuration Variable " & curVariable & ":"

        Print Chr(9) & "Description: " & Chr(9) & tConfigVar.Description

        Print Chr(9) & "Entity: " & Chr(9) & tConfigVar.entity

        Print Chr(9) & "Index: " & Chr(9) & tConfigVar.index

        Print Chr(9) & "Sub-index: " & Chr(9) & tConfigVar.subindex

        Print Chr(9) & "Type: " & Chr(9) & tConfigVar.Type

        Print Chr(9) & "Values: "

        For curConfig = 0 To GetConfigCount()-1

             Print Chr(9) & Chr(9) & "Config " & curConfig & Chr(9) & tConfigVar.values(curConfig)

        Next curConfig

    Next curVariable

 

End Sub

 

 

See Also

Configuration Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC