Interface ZOSAPI::Tools::IMaterialsCatalog

Definition:

Inherits from:

• ZOSAPI.Tools.ISystemTool

Members

• AR
• CanCancel
• Cancel
• CatalogComment
• Close
• Comment
• CR
• D0
• D1
• D2
• dPgF
• E0
• E1
• ErrorMessage
• ExcludeSubstitution
• FR
• GetAllCatalogs
• GetAllMaterials
• GetCoefficientName
• GetFitCoefficient
• GetInternalBirefringenceData
• GetInternalTransmissionData
• HasHeatConductivity
• HasKnoopHardness
• HasPoissonRatio
• HasSpecificHeatCapacity
• HasYoungsModulus
• HeatConductivity
• IgnoreThermalExpansion
• IsAsynchronous
• IsFiniteDuration
• IsRunning
• IsValid
• KnoopHardness
• Ltk
• MaterialFormula
• MaterialStatus
• MaximumWavelength
• MeltFreq
• MetaMaterial
• MinimumWavelength
• Nd
• NumberOfFitCoefficients
• p
• PoissonRatio
• PR
• Progress
• RelCost
• Run
• RunAndWaitForCompletion
• RunAndWaitWithTimeout
• SaveCatalog
• SelectedCatalog
• SelectedMaterial
• SetFitCoefficient
• SpecificHeatCapacity
• SR
• Status
• Succeeded
• TCE
• Temp
• Vd
• WaitForCompletion
• WaitWithTimeout
• YoungsModulus

Properties

Property SelectedCatalog

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.SelectedCatalog

Return type: string

Property SelectedMaterial

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.SelectedMaterial

Return type: string

Property NumberOfFitCoefficients

Definition:

int ZOSAPI.Tools.IMaterialsCatalog.NumberOfFitCoefficients

Return type: int

Property CatalogComment

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.CatalogComment

Return type: string

Property MaterialFormula

Definition:

MaterialFormulas ZOSAPI.Tools.IMaterialsCatalog.MaterialFormula

Return type: MaterialFormulas

Property MaterialStatus

Definition:

MaterialStatuses ZOSAPI.Tools.IMaterialsCatalog.MaterialStatus

Return type: MaterialStatuses

Property D0

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.D0

Return type: double

Property D1

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.D1

Return type: double

Property D2

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.D2

Return type: double

Property E0

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.E0

Return type: double

Property E1

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.E1

Return type: double

Property Ltk

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.Ltk

Return type: double

Property TCE

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.TCE

Return type: double

Property Temp

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.Temp

Return type: double

Property p

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.p

Return type: double

Property dPgF

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.dPgF

Return type: double

Property MinimumWavelength

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.MinimumWavelength

Return type: double

Property MaximumWavelength

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.MaximumWavelength

Return type: double

Property IgnoreThermalExpansion

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.IgnoreThermalExpansion

Return type: bool

Property ExcludeSubstitution

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.ExcludeSubstitution

Return type: bool

Property MetaMaterial

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.MetaMaterial

Return type: bool

Property MeltFreq

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.MeltFreq

Return type: string

Property Comment

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.Comment

Return type: string

Property RelCost

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.RelCost

Return type: string

Property CR

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.CR

Return type: string

Property FR

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.FR

Return type: string

Property SR

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.SR

Return type: string

Property AR

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.AR

Return type: string

Property PR

Definition:

string ZOSAPI.Tools.IMaterialsCatalog.PR

Return type: string

Property Nd

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.Nd

Return type: double

Property Vd

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.Vd

Return type: double

Property YoungsModulus

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.YoungsModulus

Return type: double

Property HasYoungsModulus

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.HasYoungsModulus

Return type: bool

Property PoissonRatio

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.PoissonRatio

Return type: double

Property HasPoissonRatio

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.HasPoissonRatio

Return type: bool

Property KnoopHardness

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.KnoopHardness

Return type: double

Property HasKnoopHardness

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.HasKnoopHardness

Return type: bool

Property SpecificHeatCapacity

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.SpecificHeatCapacity

Return type: double

Property HasSpecificHeatCapacity

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.HasSpecificHeatCapacity

Return type: bool

Property HeatConductivity

Definition:

double ZOSAPI.Tools.IMaterialsCatalog.HeatConductivity

Return type: double

Property HasHeatConductivity

Definition:

bool ZOSAPI.Tools.IMaterialsCatalog.HasHeatConductivity

Return type: bool

Public functions

Function GetAllCatalogs

string[] ZOSAPI.Tools.IMaterialsCatalog.GetAllCatalogs()

Return type: string[]

Function GetAllMaterials

string[] ZOSAPI.Tools.IMaterialsCatalog.GetAllMaterials()

Return type: string[]

Function GetCoefficientName

string ZOSAPI.Tools.IMaterialsCatalog.GetCoefficientName(int coeff)

Parameters:

• int coeff

Return type: string

Function GetFitCoefficient

double ZOSAPI.Tools.IMaterialsCatalog.GetFitCoefficient(int coeff)

Returns the individual dispersion coefficient (0-indexed)

Parameters:

• coeff:

Returns:

Parameters:

• int coeff

Return type: double

Function SetFitCoefficient

void ZOSAPI.Tools.IMaterialsCatalog.SetFitCoefficient(int coeff, double Value)

Changes the individual dispersion coefficient (0-indexed)

Parameters:

• coeff:
• Value:

Parameters:

• int coeff
• double Value

Return type: void

Function SaveCatalog

bool ZOSAPI.Tools.IMaterialsCatalog.SaveCatalog()

Saves modified Material data. Needs to be applied for each modified glass.

Returns:

Return type: bool

Function GetInternalTransmissionData

IInternalTransmissionData ZOSAPI.Tools.IMaterialsCatalog.GetInternalTransmissionData()

Return type: IInternalTransmissionData

Function GetInternalBirefringenceData

IInternalBirefringenceData ZOSAPI.Tools.IMaterialsCatalog.GetInternalBirefringenceData()

Return type: IInternalBirefringenceData