ZOSAPI.Editors.NCE.INCEDiffractionData Interface Reference
Last update: 17.07.2025Object properties Diffraction tab. This interface can be accessed via the INCERow interface. More...
Public Member Functions | |
| string[] | GetAvailableDLLs () |
| string | GetReflectParameterName (int paramIdx) |
| Gets the name of the specified reflect parameter. | |
| double | GetReflectParameterValue (int paramIdx) |
| Gets the value of the specified reflect parameter. | |
| bool | SetReflectParameterValue (int paramIdx, double Value) |
| Sets the value of the specified reflect parameter. | |
| string | GetTransmitParamaterName (int paramIdx) |
| Gets the name of the specified transmit parameter. | |
| double | GetTransmitParameterValue (int paramIdx) |
| Gets the value of the specified transmit parameter. | |
| bool | SetTransmitParameterValue (int paramIdx, double Value) |
| Sets the value of the specified transmit parameter. | |
Properties | |
| bool | IsDiffractionAvailable [get] |
| DiffractionSplitType | Split [get, set] |
| string | DLL [get, set] |
| bool | IsDLLRequired [get] |
| int | StartOrder [get, set] |
| int | StopOrder [get, set] |
| int | NumberOfParameters [get] |
Detailed Description
Object properties Diffraction tab. This interface can be accessed via the INCERow interface.
Member Function Documentation
◆ GetAvailableDLLs()
| string[] ZOSAPI.Editors.NCE.INCEDiffractionData.GetAvailableDLLs | ( | ) |
◆ GetReflectParameterName()
| string ZOSAPI.Editors.NCE.INCEDiffractionData.GetReflectParameterName | ( | int | paramIdx | ) |
Gets the name of the specified reflect parameter.
- Parameters
-
paramIdx Index of the parameter (0 to NumberOfParameters-1).
- Returns
- The parameter name if the index is valid; otherwise, an empty string.
◆ GetReflectParameterValue()
| double ZOSAPI.Editors.NCE.INCEDiffractionData.GetReflectParameterValue | ( | int | paramIdx | ) |
Gets the value of the specified reflect parameter.
- Parameters
-
paramIdx Index of the parameter (0 to NumberOfParameters-1).
- Returns
- The parameter value if the index is valid; otherwise, .0.0
◆ GetTransmitParamaterName()
| string ZOSAPI.Editors.NCE.INCEDiffractionData.GetTransmitParamaterName | ( | int | paramIdx | ) |
Gets the name of the specified transmit parameter.
- Parameters
-
paramIdx Index of the parameter (0 to NumberOfParameters-1).
- Returns
- The parameter name if the index is valid; otherwise, an empty string.
◆ GetTransmitParameterValue()
| double ZOSAPI.Editors.NCE.INCEDiffractionData.GetTransmitParameterValue | ( | int | paramIdx | ) |
Gets the value of the specified transmit parameter.
- Parameters
-
paramIdx Index of the parameter (0 to NumberOfParameters-1).
- Returns
- The parameter value if the index is valid; otherwise, .0.0
◆ SetReflectParameterValue()
| bool ZOSAPI.Editors.NCE.INCEDiffractionData.SetReflectParameterValue | ( | int | paramIdx, |
| double | Value | ||
| ) |
Sets the value of the specified reflect parameter.
- Parameters
-
paramIdx Index of the parameter (0 to NumberOfParameters-1). Value The new parameter value.
- Returns
- if the index is valid; otherwise,true.false
◆ SetTransmitParameterValue()
| bool ZOSAPI.Editors.NCE.INCEDiffractionData.SetTransmitParameterValue | ( | int | paramIdx, |
| double | Value | ||
| ) |
Sets the value of the specified transmit parameter.
- Parameters
-
paramIdx Index of the parameter (0 to NumberOfParameters-1). Value The new parameter value.
- Returns
- if the index is valid; otherwise,true.false
Property Documentation
◆ DLL
|
getset |
◆ IsDiffractionAvailable
|
get |
◆ IsDLLRequired
|
get |
◆ NumberOfParameters
|
get |
◆ Split
|
getset |
◆ StartOrder
|
getset |
◆ StopOrder
|
getset |