Interface ZOSAPI::Editors::LDE::ISTAR_DeformationsFEAData

Definition:

Members

• AreDeformationsApplied
• AreDeformationsImported
• Filename
• GetFEAPointsSafe
• GetFEAPointsSafeOld
• GetFEAPointsWithAutoWeightsSafe
• GetTransformedFEAPointsNoImportRequired
• GetTransformedFEAPointsSafe
• GetTransformValues
• ImportDeformations
• ImportDeformations_1
• Name
• NumberOfDataPoints
• SurfaceNumber
• UnloadData
• UnloadDataAndKeepFiles

Properties

Property SurfaceNumber

Definition:

int ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.SurfaceNumber

Return type: int

Property AreDeformationsImported

Definition:

bool ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.AreDeformationsImported

Return type: bool

Property NumberOfDataPoints

Definition:

int ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.NumberOfDataPoints

Return type: int

Property Filename

Definition:

string ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.Filename

Return type: string

Property Name

Definition:

string ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.Name

Return type: string

Public functions

Function ImportDeformations

void ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.ImportDeformations(string filename)

Parameters:

• string filename

Return type: void

Function ImportDeformations_1

int ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.ImportDeformations_1(string filename)

Import Deformation FEA data from a file.

Parameters:

• filename: Full path of the file containing the FEA data

Returns:

Returns an integer signalling the status of the operation according to the following: table {"type":"element","name":"table","attributes":{"cols":"2","rows":"5"},"children":[{"type":"element","name":"row","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"entry","attributes":{"thead":"yes"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"Value "}]},{"type":"text","text":"\n"}]},{"type":"element","name":"entry","attributes":{"thead":"yes"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"Meaning "}]},{"type":"text","text":"\n"}]}]},{"type":"text","text":"\n"},{"type":"element","name":"row","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"0 "}]},{"type":"text","text":"\n"}]},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"The file has no header, or the file contains the correct type of data according to its header. "}]},{"type":"text","text":"\n"}]}]},{"type":"text","text":"\n"},{"type":"element","name":"row","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"1 "}]},{"type":"text","text":"\n"}]},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"OpticStudio was unable to open the file. "}]},{"type":"text","text":"\n"}]}]},{"type":"text","text":"\n"},{"type":"element","name":"row","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"2 "}]},{"type":"text","text":"\n"}]},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"The file has a malformed header. "}]},{"type":"text","text":"\n"}]}]},{"type":"text","text":"\n"},{"type":"element","name":"row","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"3 "}]},{"type":"text","text":"\n"}]},{"type":"element","name":"entry","attributes":{"thead":"no"},"children":[{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"The file contains the wrong type of data according to its header. "}]},{"type":"text","text":"\n"}]}]},{"type":"text","text":"\n"}]}

Parameters:

• string filename

Return type: int

Function GetFEAPointsSafeOld

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetFEAPointsSafeOld()

Return type: ISTAR_PointWithDeformation[]

Function GetFEAPointsSafe

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetFEAPointsSafe()

Return type: ISTAR_PointWithDeformation[]

Function GetFEAPointsWithAutoWeightsSafe

ISTAR_PointWithDeformationAndWeight[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetFEAPointsWithAutoWeightsSafe(int weightVariation)

Returns FEA points with automatically calculated weights that attempt to account for unevenly spaced points in the FEA data set.

Parameters:

• weightVariation: 1 -> XY plane weights only; 2 -> XY, XZ and YZ weights combined

Returns:

Parameters:

• int weightVariation

Return type: ISTAR_PointWithDeformationAndWeight[]

Function AreDeformationsApplied

bool ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.AreDeformationsApplied()

Return type: bool

Function UnloadData

void ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.UnloadData()

Return type: void

Function UnloadDataAndKeepFiles

void ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.UnloadDataAndKeepFiles()

Return type: void

Function GetTransformValues

ICoordinateTransform ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetTransformValues(int transformType)

Transform types are 0 - User coordinate adapter transform, 1 - GRSO to Local transform, 2 - Total transform (matrix product of 0 and 1)

Parameters:

• int transformType

Return type: ICoordinateTransform

Function GetTransformedFEAPointsSafe

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetTransformedFEAPointsSafe(int coordinateOption)

Returns points after applying the selected transform. Option 0 returns local OpticStudio coordinates (surface-specific) and option 1 returns global OpticStudio coordinates referenced to the GRSO.

Parameters:

• int coordinateOption

Return type: ISTAR_PointWithDeformation[]

Function GetTransformedFEAPointsNoImportRequired

ISTAR_PointWithDeformation[] ZOSAPI.Editors.LDE.ISTAR_DeformationsFEAData.GetTransformedFEAPointsNoImportRequired(String filename, int adaptCase, double[,] adapterR, double[] adapterO, int coordinateOption)

Returns points after applying the selected transform. This version does not require a prior call to ImportDeformations and thus no lens update is issued. Option 0 returns local OpticStudio coordinates (surface-specific) and option 1 returns global OpticStudio coordinates referenced to the GRSO. adaptCase usage to indicate FEA data coord system in the file: 0-InOSLocal, 1-InOSGlobal, 2-ToOSLocalViaTransform, 3-ToOSGlobalViaTransform.

Parameters:

• String filename

• int adaptCase

• double adapterR<!-- TODO:

• array {"type":"element","name":"array","attributes":{},"children":[{"type":"text","text":"[,]"}]} -->

• double[] adapterO

• int coordinateOption

Return type: ISTAR_PointWithDeformation[]