Interface ZOSAPI::Tools::General::ILensCatalogLens

Definition:

Members

• EFL
• EPD
• InsertLensNonSeq
• InsertLensSeq
• LensName
• LoadLens
• LoadNewLensNonSeq
• LoadNewLensSeq
• NumberOfElements
• Shape
• Telecentric
• Type
• Vendor

Properties

Property Vendor

Definition:

string ZOSAPI.Tools.General.ILensCatalogLens.Vendor

Return type: string

Property LensName

Definition:

string ZOSAPI.Tools.General.ILensCatalogLens.LensName

Return type: string

Property EFL

Definition:

double ZOSAPI.Tools.General.ILensCatalogLens.EFL

Return type: double

Property EPD

Definition:

double ZOSAPI.Tools.General.ILensCatalogLens.EPD

Return type: double

Property Shape

Definition:

LensShape ZOSAPI.Tools.General.ILensCatalogLens.Shape

Return type: LensShape

Property Type

Definition:

LensType ZOSAPI.Tools.General.ILensCatalogLens.Type

Return type: LensType

Property NumberOfElements

Definition:

int ZOSAPI.Tools.General.ILensCatalogLens.NumberOfElements

Return type: int

Property Telecentric

Definition:

bool ZOSAPI.Tools.General.ILensCatalogLens.Telecentric

Return type: bool

Public functions

Function LoadLens

void ZOSAPI.Tools.General.ILensCatalogLens.LoadLens(bool saveIfNeeded)

Loads this lens. Note that the current system will be replaced entirely.

Parameters:

• saveIfNeeded: If set to true, the current system will be saved (if needed) before loading the new lens.

Parameters:

• bool saveIfNeeded

Return type: void

Function LoadNewLensSeq

IOpticalSystem ZOSAPI.Tools.General.ILensCatalogLens.LoadNewLensSeq()

Creates a new sequential system from this lens.

Returns:

The new system

Return type: IOpticalSystem

Function LoadNewLensNonSeq

IOpticalSystem ZOSAPI.Tools.General.ILensCatalogLens.LoadNewLensNonSeq()

Creates a new non-sequential system from this lens.

Returns:

The new system

Return type: IOpticalSystem

Function InsertLensSeq

bool ZOSAPI.Tools.General.ILensCatalogLens.InsertLensSeq(int atSurface, bool ignoreObject, bool reverseSurfGeom)

Inserts this lens into the current sequential system, at the specific surface. Note that this will fail if the current system is not sequential.

Parameters:

• atSurface: Position to insert the lens.
• ignoreObject:
• reverseSurfGeom: Change sign of surface geometry in mirror space.

Returns:

true if the lens was inserted; otherwise false.

Parameters:

• int atSurface
• bool ignoreObject
• bool reverseSurfGeom

Return type: bool

Function InsertLensNonSeq

bool ZOSAPI.Tools.General.ILensCatalogLens.InsertLensNonSeq()

Convert this lens to non-sequential components, and add them to the end of the current system. Note that this will fail if the current system is sequential.

Returns:

true if the lens was inserted; otherwise false.

Return type: bool