ZOSAPI.Tools.IDesignLockdown Interface Reference
Last update: 17.07.2025Interfaces and methods for validating a sequential design, prior to manufacturing or conversion to non-sequential. This interface can be accessed via the IOpticalSystemTools interface. More...
Properties | |
| int | DecimalPrecision [get, set] |
| Controls how many decimal places are included when UsePrecisionRounding is turned on. | |
| bool | ExcludePickups [get, set] |
If true, pickup solves will be retained in the converted system; otherwise all solves will be removed including pickups. | |
| bool | UsePrecisionRounding [get, set] |
| Controls whether or not editor values will be rounded in the output system. | |
| bool | FixModelGlasses [get, set] |
| Controls whether any model glass solves will be converted to the nearest material in the selected catalogs. | |
| bool | ConvertSDToMaxApertures [get, set] |
| Controls whether floating semi-diamters will be treating as if the have a Maximum solve attached. | |
 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. | |
Additional Inherited Members | |
| 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. | |
Detailed Description
Interfaces and methods for validating a sequential design, prior to manufacturing or conversion to non-sequential. This interface can be accessed via the IOpticalSystemTools interface.
Property Documentation
◆ ConvertSDToMaxApertures
|
getset |
Controls whether floating semi-diamters will be treating as if the have a Maximum solve attached.
◆ DecimalPrecision
|
getset |
Controls how many decimal places are included when UsePrecisionRounding is turned on.
◆ ExcludePickups
|
getset |
If true, pickup solves will be retained in the converted system; otherwise all solves will be removed including pickups.
◆ FixModelGlasses
|
getset |
Controls whether any model glass solves will be converted to the nearest material in the selected catalogs.
◆ UsePrecisionRounding
|
getset |
Controls whether or not editor values will be rounded in the output system.
