ZOS-API interface 2024 R2 SP02

ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering Interface Reference

Last update: 17.07.2025

Volume Physics Model - DLL Defined Scatering. This interface can be accessed via the INCEVolumePhysicsData interface. More...

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

Public Member Functions

string[] GetAvailableDLLs ()
 
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 (0 to NumberOfParameters).
 
bool SetParameterValue (int paramIdx, double Value)
 Gets the value of the specified parameter.
 

Properties

string DLL [get, set]
 
double MeanPath [get, set]
 
bool MeanPathRequired [get]
 
double Angle [get, set]
 
bool AngleRequired [get]
 
int NumberOfParameters [get]
 
- Properties inherited from ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings
VolumePhysicsModelType Type [get]
 
bool IsValid [get]
 
IVPMS_None _S_None [get]
 
IVMPS_AngleScattering _S_AngleScattering [get]
 
IVMPS_DLLDefinedScattering _S_DLLDefinedScattering [get]
 
IVMPS_PhotoluminscenceModel _S_PhotoluminescenceModel [get]
 

Detailed Description

Volume Physics Model - DLL Defined Scatering. This interface can be accessed via the INCEVolumePhysicsData interface.

Member Function Documentation

◆ GetAvailableDLLs()

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

◆ GetParameterName()

string ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.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.IVMPS_DLLDefinedScattering.GetParameterValue ( int  paramIdx)

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

Parameters
paramIdxIndex of the parameter.
Returns
The value of the parameter if the index is valid; otherwise,
0.0
.

◆ SetParameterValue()

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

Gets the value of the specified parameter.

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

Property Documentation

◆ Angle

double ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.Angle
getset

◆ AngleRequired

bool ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.AngleRequired
get

◆ DLL

string ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.DLL
getset

◆ MeanPath

double ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.MeanPath
getset

◆ MeanPathRequired

bool ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.MeanPathRequired
get

◆ NumberOfParameters

int ZOSAPI.Editors.NCE.IVMPS_DLLDefinedScattering.NumberOfParameters
get

Connect with Ansys