Inheritance diagram for ZOSAPI.Tools.OptimizationTools.IFindBestAsphere:

Properties
int	FirstSurface `[get, set]`
	Gets or sets the first surface to consider adding an asphere to (0 to Editors.LDE.ILensDataEditor.NumberOfSurfaces-2).

int	LastSurface `[get, set]`
	Gets or sets the last surface to consider adding an asphere to (1 to Editors.LDE.ILensDataEditor.NumberOfSurfaces-1).

FindBestAsphereTypes	AsphereType `[get, set]`
	Gets or sets the asphere type (Conic, 4thOrder, 8thOrder, 10thOrder, 12thOrder) from FindBestAsphereTypes.

double	StartMeritFunction `[get]`

double	BestMeritFunction `[get]`

int	BestSurface `[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`.

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.

Property Documentation

◆ AsphereType

FindBestAsphereTypes ZOSAPI.Tools.OptimizationTools.IFindBestAsphere.AsphereType

getset

Gets or sets the asphere type (Conic, 4thOrder, 8thOrder, 10thOrder, 12thOrder) from FindBestAsphereTypes.

The asphere type.

double ZOSAPI.Tools.OptimizationTools.IFindBestAsphere.BestMeritFunction

get

int ZOSAPI.Tools.OptimizationTools.IFindBestAsphere.BestSurface

get

int ZOSAPI.Tools.OptimizationTools.IFindBestAsphere.FirstSurface

getset

Gets or sets the first surface to consider adding an asphere to (0 to Editors.LDE.ILensDataEditor.NumberOfSurfaces-2).

The first surface.

int ZOSAPI.Tools.OptimizationTools.IFindBestAsphere.LastSurface

getset

Gets or sets the last surface to consider adding an asphere to (1 to Editors.LDE.ILensDataEditor.NumberOfSurfaces-1).

The last surface.

double ZOSAPI.Tools.OptimizationTools.IFindBestAsphere.StartMeritFunction

get