Interface ZOSAPI::Tools::General::ILensCatalogs

Definition:

Interfaces and methods for searching the available Lens Catalogs. This interface can be accessed via the IOpticalSystemTools interface.

Inherits from:

• ZOSAPI.Tools.ISystemTool

Members

• CanCancel
• Cancel
• Close
• ErrorMessage
• GetAllVendors
• GetResult
• IncShapeBi
• IncShapeEqui
• IncShapeMeniscus
• IncShapePlano
• IncTypeAspheric
• IncTypeGRIN
• IncTypeSpherical
• IncTypeToroidal
• IsAsynchronous
• IsFiniteDuration
• IsRunning
• IsValid
• LensesForVendor
• MatchingLenses
• MaxEFL
• MaxEPD
• MinEFL
• MinEPD
• NumberOfElements
• Progress
• Run
• RunAndWaitForCompletion
• RunAndWaitWithTimeout
• SelectedVendor
• SetNumberOfElementsAny
• Status
• Succeeded
• UseEFL
• UseEPD
• WaitForCompletion
• WaitWithTimeout

Properties

Property SelectedVendor

Definition:

string ZOSAPI.Tools.General.ILensCatalogs.SelectedVendor

Gets or sets the current vendor to be used for the search.

The selected vendor.

Return type: string

Property UseEFL

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.UseEFL

Use the MinEFL and MaxEFL effective focal length criteria in the search.

true if using focal length criteria; otherwise, false.

Return type: bool

Property MinEFL

Definition:

double ZOSAPI.Tools.General.ILensCatalogs.MinEFL

Minimum effective focal length.

The minimum EFL.

Return type: double

Property MaxEFL

Definition:

double ZOSAPI.Tools.General.ILensCatalogs.MaxEFL

Maximum effective focal length.

The maximum EFL.

Return type: double

Property UseEPD

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.UseEPD

Use the MinEPD and MaxEPD entrance pupil diameter criteria in the search.

true if using pupil diameter criteria; otherwise, false.

Return type: bool

Property MinEPD

Definition:

double ZOSAPI.Tools.General.ILensCatalogs.MinEPD

Minimum entrance pupil diameter.

The minimum EPD.

Return type: double

Property MaxEPD

Definition:

double ZOSAPI.Tools.General.ILensCatalogs.MaxEPD

Maximum entrance pupil diameter.

The maximum EPD.

Return type: double

Property IncShapeEqui

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncShapeEqui

Return type: bool

Property IncShapeBi

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncShapeBi

Return type: bool

Property IncShapePlano

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncShapePlano

Return type: bool

Property IncShapeMeniscus

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncShapeMeniscus

Return type: bool

Property IncTypeSpherical

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncTypeSpherical

Return type: bool

Property IncTypeGRIN

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncTypeGRIN

Return type: bool

Property IncTypeAspheric

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncTypeAspheric

Return type: bool

Property IncTypeToroidal

Definition:

bool ZOSAPI.Tools.General.ILensCatalogs.IncTypeToroidal

Return type: bool

Property NumberOfElements

Definition:

int ZOSAPI.Tools.General.ILensCatalogs.NumberOfElements

Gets or sets the number of elements to use in the search.

The number of elements (0 for Any).

Return type: int

Property MatchingLenses

Definition:

int ZOSAPI.Tools.General.ILensCatalogs.MatchingLenses

Gets the number matching lenses. You must first call one of the ISystemTool.Run methods to perform the search first.

The number of matching lenses from the previous search.

Return type: int

Property LensesForVendor

Definition:

int ZOSAPI.Tools.General.ILensCatalogs.LensesForVendor

Gets the number of lenses for current vendor (selected via SelectedVendor).

The number of lenses in the vendors catalog.

Return type: int

Public functions

Function GetAllVendors

string[] ZOSAPI.Tools.General.ILensCatalogs.GetAllVendors()

Return type: string[]

Function SetNumberOfElementsAny

void ZOSAPI.Tools.General.ILensCatalogs.SetNumberOfElementsAny()

Do not use the NumberOfElements search criteria.

Return type: void

Function GetResult

ILensCatalogLens ZOSAPI.Tools.General.ILensCatalogs.GetResult(int index)

Gets the specified search result.

Parameters:

• index: The index (0 to MatchingLenses-1).

Returns:

Parameters:

• int index

Return type: ILensCatalogLens