Interface ZOSAPI::Editors::NCE::IIMS_GRIN

Definition:

Index Model - Gradient Index. This interface can be accessed via the INCEIndexData interface.

Inherits from:

• ZOSAPI.Editors.NCE.IIndexModelSettings

Members

• _S_Birefringent
• _S_GRIN
• _S_Isotropic
• DLL
• File
• GetAvailableDLLs
• GetAvailableFiles
• GetParameterName
• GetParameterValue
• IsValid
• MaximumStepSize
• NumberOfParameters
• SetParameterValue
• Type
• UsesFile

Properties

Property DLL

Definition:

string ZOSAPI.Editors.NCE.IIMS_GRIN.DLL

Return type: string

Property File

Definition:

string ZOSAPI.Editors.NCE.IIMS_GRIN.File

Return type: string

Property UsesFile

Definition:

bool ZOSAPI.Editors.NCE.IIMS_GRIN.UsesFile

Return type: bool

Property MaximumStepSize

Definition:

double ZOSAPI.Editors.NCE.IIMS_GRIN.MaximumStepSize

Return type: double

Property NumberOfParameters

Definition:

int ZOSAPI.Editors.NCE.IIMS_GRIN.NumberOfParameters

Return type: int

Public functions

Function GetAvailableDLLs

string[] ZOSAPI.Editors.NCE.IIMS_GRIN.GetAvailableDLLs()

Return type: string[]

Function GetAvailableFiles

string[] ZOSAPI.Editors.NCE.IIMS_GRIN.GetAvailableFiles()

Return type: string[]

Function GetParameterName

string ZOSAPI.Editors.NCE.IIMS_GRIN.GetParameterName(int paramIdx)

Gets the name of the specified parameter (0 to NumberOfParameters).

Parameters:

• paramIdx: Index of the parameter.

Returns:

The name of the parameter if the index is valid; otherwise, an empty string.

Parameters:

• int paramIdx

Return type: string

Function GetParameterValue

double ZOSAPI.Editors.NCE.IIMS_GRIN.GetParameterValue(int paramIdx)

Gets the value of the specified parameter.

Parameters:

• paramIdx: Index of the parameter (0-based).

Returns:

The value of the parameter if the index is valid; otherwise,

0.0

.

Parameters:

• int paramIdx

Return type: double

Function SetParameterValue

bool ZOSAPI.Editors.NCE.IIMS_GRIN.SetParameterValue(int paramIdx, double Value)

Sets the value of the specified parameter.

Parameters:

• paramIdx: Index of the parameter (0-based).
• Value: The new value for parameter.

Returns:

true

if the index is valid; otherwise,

false

.

Parameters:

• int paramIdx
• double Value

Return type: bool