ZOSAPI.Tools.Layouts.ICrossSectionExport Interface Reference

Interfaces and methods for saving an output image for selected parts of the system. This interface can be accessed via the IOpticalSystemTools interface. More...

Public Member Functions
void	SetWavelengthsAll ()
void	SetFieldsAll ()
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
bool	SaveImageAsFile [get, set]
string	OutputFileName [get, set]
bool	IsValidFileName [get]
int	OutputPixelWidth [get, set]
int	OutputPixelHeight [get, set]
int	StartSurface [get, set]
	The first surface which will be available in the output image. If set to -1, every surface from the beginning to the EndSurface will be available.
int	EndSurface [get, set]
	The last surface which will be available in the output image. If set to -1, every surface after the StartSurface will be available.
int	NumberOfRays [get, set]
	The number of rays. Must be greater than 0.
double	YStretch [get, set]
int	Wavelength [get, set]
	The wavelength index to use. If set to -1, all wavelengths will be displayed.
int	Field [get, set]
	The field index to use. If set to -1, all fields will be displayed.
ColorRaysByCrossSectionOptions	ColorRaysBy [get, set]
	The value by which to color rays by. ColorRaysBy
double	UpperPupil [get, set]
double	LowerPupil [get, set]
bool	FletchRays [get, set]
bool	DeleteVignetted [get, set]
bool	MarginalAndChiefRayOnly [get, set]
LineThicknessOptions	SurfaceLineThickness [get, set]
LineThicknessOptions	RaysLineThickness [get, set]
int	Configuration [get, set]
IImageExportData	ImageExportData [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.

Detailed Description

Member Function Documentation

◆ SetFieldsAll()

◆ SetWavelengthsAll()

Property Documentation

◆ ColorRaysBy

◆ Configuration

◆ DeleteVignetted

◆ EndSurface

◆ Field

◆ FletchRays

◆ ImageExportData

◆ IsValidFileName

◆ LowerPupil

◆ MarginalAndChiefRayOnly

◆ NumberOfRays

◆ OutputFileName

◆ OutputPixelHeight

◆ OutputPixelWidth

◆ RaysLineThickness

◆ SaveImageAsFile

◆ StartSurface

◆ SurfaceLineThickness

◆ UpperPupil

◆ Wavelength

◆ YStretch