ZOSAPI.Tools.General.ILensCatalogs Interface Reference
Last update: 17.07.2025Interfaces and methods for searching the available Lens Catalogs. This interface can be accessed via the IOpticalSystemTools interface. More...
Public Member Functions | |
| string[] | GetAllVendors () |
| void | SetNumberOfElementsAny () |
| Do not use the NumberOfElements search criteria. | |
| ILensCatalogLens | GetResult (int index) |
| Gets the specified search result. | |
 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 | SelectedVendor [get, set] |
| Gets or sets the current vendor to be used for the search. | |
| bool | UseEFL [get, set] |
| Use the MinEFL and MaxEFL effective focal length criteria in the search. | |
| double | MinEFL [get, set] |
| Minimum effective focal length. | |
| double | MaxEFL [get, set] |
| Maximum effective focal length. | |
| bool | UseEPD [get, set] |
| Use the MinEPD and MaxEPD entrance pupil diameter criteria in the search. | |
| double | MinEPD [get, set] |
| Minimum entrance pupil diameter. | |
| double | MaxEPD [get, set] |
| Maximum entrance pupil diameter. | |
| bool | IncShapeEqui [get, set] |
| bool | IncShapeBi [get, set] |
| bool | IncShapePlano [get, set] |
| bool | IncShapeMeniscus [get, set] |
| bool | IncTypeSpherical [get, set] |
| bool | IncTypeGRIN [get, set] |
| bool | IncTypeAspheric [get, set] |
| bool | IncTypeToroidal [get, set] |
| int | NumberOfElements [get, set] |
| Gets or sets the number of elements to use in the search. | |
| int | MatchingLenses [get] |
| Gets the number matching lenses. You must first call one of the ISystemTool.Run methods to perform the search first. | |
| int | LensesForVendor [get] |
| Gets the number of lenses for current vendor (selected via SelectedVendor). | |
| 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. | |
Detailed Description
Interfaces and methods for searching the available Lens Catalogs. This interface can be accessed via the IOpticalSystemTools interface.
Member Function Documentation
◆ GetAllVendors()
| string[] ZOSAPI.Tools.General.ILensCatalogs.GetAllVendors | ( | ) |
◆ GetResult()
| ILensCatalogLens ZOSAPI.Tools.General.ILensCatalogs.GetResult | ( | int | index | ) |
Gets the specified search result.
- Parameters
-
index The index (0 to MatchingLenses-1).
- Returns
◆ SetNumberOfElementsAny()
| void ZOSAPI.Tools.General.ILensCatalogs.SetNumberOfElementsAny | ( | ) |
Do not use the NumberOfElements search criteria.
Property Documentation
◆ IncShapeBi
|
getset |
◆ IncShapeEqui
|
getset |
◆ IncShapeMeniscus
|
getset |
◆ IncShapePlano
|
getset |
◆ IncTypeAspheric
|
getset |
◆ IncTypeGRIN
|
getset |
◆ IncTypeSpherical
|
getset |
◆ IncTypeToroidal
|
getset |
◆ LensesForVendor
|
get |
Gets the number of lenses for current vendor (selected via SelectedVendor).
The number of lenses in the vendors catalog.
◆ MatchingLenses
|
get |
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.
◆ MaxEFL
|
getset |
Maximum effective focal length.
The maximum EFL.
◆ MaxEPD
|
getset |
Maximum entrance pupil diameter.
The maximum EPD.
◆ MinEFL
|
getset |
Minimum effective focal length.
The minimum EFL.
◆ MinEPD
|
getset |
Minimum entrance pupil diameter.
The minimum EPD.
◆ NumberOfElements
|
getset |
Gets or sets the number of elements to use in the search.
The number of elements (0 for Any).
◆ SelectedVendor
|
getset |
Gets or sets the current vendor to be used for the search.
The selected vendor.
◆ UseEFL
|
getset |
Use the MinEFL and MaxEFL effective focal length criteria in the search.
true if using focal length criteria; otherwise, false.
◆ UseEPD
|
getset |
Use the MinEPD and MaxEPD entrance pupil diameter criteria in the search.
true if using pupil diameter criteria; otherwise, false.
