ZOSAPI.Tools.IMaterialsCatalog Interface Reference

Public Member Functions
string[]	GetAllCatalogs ()
string[]	GetAllMaterials ()
string	GetCoefficientName (int coeff)
double	GetFitCoefficient (int coeff)
	Returns the individual dispersion coefficient (0-indexed)
void	SetFitCoefficient (int coeff, double Value)
	Changes the individual dispersion coefficient (0-indexed)
bool	SaveCatalog ()
	Saves modified Material data. Needs to be applied for each modified glass.
IInternalTransmissionData	GetInternalTransmissionData ()
IInternalBirefringenceData	GetInternalBirefringenceData ()
Public Member Functions inherited from ZOSAPI.Tools.ISystemTool
bool	Run ()
	Start the tool. Note that for synchronous tools (see IsAsynchronous), this call will block until completion. If it is asynchronous it will start running but return immediately.
bool	RunAndWaitForCompletion ()
	Sames as calling Run followed by WaitForCompletion.
bool	WaitForCompletion ()
	Waits for the asynchronous tool to complete.
bool	Cancel ()
	Cancels the currently running asynchronous tool.
bool	Close ()
	Closes this tool and frees up and associated resources.
RunStatus	WaitWithTimeout (double timeOutSeconds)
	Waits for the currently running tool to complete, with a specified time out value. Note that if the timeout is exceeded this method will return, however the tool will continue to run. Also note that this method will not start the tool running if it is not already.
RunStatus	RunAndWaitWithTimeout (double timeOutSeconds)
	Starts the tool running, and waits for it to complete with the specified timeout value. Note that if the timeout is exceeded this method will return, however the tool will continue to run.

Properties
string	SelectedCatalog [get, set]
string	SelectedMaterial [get, set]
int	NumberOfFitCoefficients [get]
string	CatalogComment [get, set]
MaterialFormulas	MaterialFormula [get, set]
MaterialStatuses	MaterialStatus [get, set]
double	D0 [get, set]
double	D1 [get, set]
double	D2 [get, set]
double	E0 [get, set]
double	E1 [get, set]
double	Ltk [get, set]
double	TCE [get, set]
double	Temp [get, set]
double	p [get, set]
double	dPgF [get, set]
double	MinimumWavelength [get, set]
double	MaximumWavelength [get, set]
bool	IgnoreThermalExpansion [get, set]
bool	ExcludeSubstitution [get, set]
bool	MetaMaterial [get, set]
string	MeltFreq [get, set]
string	Comment [get, set]
string	RelCost [get, set]
string	CR [get, set]
string	FR [get, set]
string	SR [get, set]
string	AR [get, set]
string	PR [get, set]
double	Nd [get]
double	Vd [get]
double	YoungsModulus [get]
bool	HasYoungsModulus [get]
double	PoissonRatio [get]
bool	HasPoissonRatio [get]
double	KnoopHardness [get]
bool	HasKnoopHardness [get]
double	SpecificHeatCapacity [get]
bool	HasSpecificHeatCapacity [get]
double	HeatConductivity [get]
bool	HasHeatConductivity [get]
Properties inherited from ZOSAPI.Tools.ISystemTool
int	Progress [get]
	Gets the progress of the current tool, if supported.
string	Status [get]
	Gets the status of the current tool, if supporoted.
bool	IsRunning [get]
	Gets a value indicating whether the tool is currently running asynchronously.
bool	CanCancel [get]
	Gets a value indicating whether the tool can be cancelled.
bool	IsAsynchronous [get]
	Gets a value indicating whether the tool runs asynchronously (i.e. on a thread).
bool	IsFiniteDuration [get]
	Gets a value indicating whether this tool will complete on its own.
bool	IsValid [get]
	Gets a value indicating whether the input settings are valid.
bool	Succeeded [get]
	Gets a value indicating whether the tool execution succeeded.
string	ErrorMessage [get]
	If Succeeded is false, get the error messages; otherwise, null.

Member Function Documentation

◆ GetAllCatalogs()

◆ GetAllMaterials()

◆ GetCoefficientName()

◆ GetFitCoefficient()

◆ GetInternalBirefringenceData()

◆ GetInternalTransmissionData()

◆ SaveCatalog()

◆ SetFitCoefficient()

Property Documentation

◆ AR

◆ CatalogComment

◆ Comment

◆ CR

◆ D0

◆ D1

◆ D2

◆ dPgF

◆ E0

◆ E1

◆ ExcludeSubstitution

◆ FR

◆ HasHeatConductivity

◆ HasKnoopHardness

◆ HasPoissonRatio

◆ HasSpecificHeatCapacity

◆ HasYoungsModulus

◆ HeatConductivity

◆ IgnoreThermalExpansion

◆ KnoopHardness

◆ Ltk

◆ MaterialFormula

◆ MaterialStatus

◆ MaximumWavelength

◆ MeltFreq

◆ MetaMaterial

◆ MinimumWavelength

◆ Nd

◆ NumberOfFitCoefficients

◆ p

◆ PoissonRatio

◆ PR

◆ RelCost

◆ SelectedCatalog

◆ SelectedMaterial

◆ SpecificHeatCapacity

◆ SR

◆ TCE

◆ Temp

◆ Vd

◆ YoungsModulus