ZOS-API interface 2024 R1

ZOSAPI.Editors.NCE.IIMS_GRIN Interface Reference

Last update: 17.07.2025

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

Inheritance diagram for ZOSAPI.Editors.NCE.IIMS_GRIN:
Inheritance graph
[legend]

Public Member Functions

string[] GetAvailableDLLs ()
 
string[] GetAvailableFiles ()
 
string GetParameterName (int paramIdx)
 Gets the name of the specified parameter (0 to NumberOfParameters).
 
double GetParameterValue (int paramIdx)
 Gets the value of the specified parameter.
 
bool SetParameterValue (int paramIdx, double Value)
 Sets the value of the specified parameter.
 

Properties

string DLL [get, set]
 
string File [get, set]
 
bool UsesFile [get]
 
double MaximumStepSize [get, set]
 
int NumberOfParameters [get]
 
- Properties inherited from ZOSAPI.Editors.NCE.IIndexModelSettings
NCEIndexType Type [get]
 
bool IsValid [get]
 
IIMS_Isotropic _S_Isotropic [get]
 
IIMS_Birefringent _S_Birefringent [get]
 
IIMS_GRIN _S_GRIN [get]
 

Detailed Description

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

Member Function Documentation

◆ GetAvailableDLLs()

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

◆ GetAvailableFiles()

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

◆ GetParameterName()

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

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

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

◆ GetParameterValue()

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

Gets the value of the specified parameter.

Parameters
paramIdxIndex of the parameter (0-based).
Returns
The value of the parameter if the index is valid; otherwise,
0.0
.

◆ SetParameterValue()

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

Sets the value of the specified parameter.

Parameters
paramIdxIndex of the parameter (0-based).
ValueThe new value for parameter.
Returns
true
if the index is valid; otherwise,
false
.

Property Documentation

◆ DLL

string ZOSAPI.Editors.NCE.IIMS_GRIN.DLL
getset

◆ File

string ZOSAPI.Editors.NCE.IIMS_GRIN.File
getset

◆ MaximumStepSize

double ZOSAPI.Editors.NCE.IIMS_GRIN.MaximumStepSize
getset

◆ NumberOfParameters

int ZOSAPI.Editors.NCE.IIMS_GRIN.NumberOfParameters
get

◆ UsesFile

bool ZOSAPI.Editors.NCE.IIMS_GRIN.UsesFile
get

Connect with Ansys