Interface ZOSAPI::Editors::LDE::ISTAR_StressFEAData

Definition:

Classes which implement this interface allow to handle stress FEA datasets.

Members

• Filename
• GetFEAPointsSafe
• GetTransformedFEAPointsNoImportRequired
• GetTransformedFEAPointsSafe
• GetTransformValues
• ImportStress
• ImportStress_1
• IsStressImported
• IsStressTensorApplied
• Name
• NumberOfDataPoints
• SurfaceNumber
• UnloadData
• UnloadDataAndKeepFiles

Properties

Property SurfaceNumber

Definition:

int ZOSAPI.Editors.LDE.ISTAR_StressFEAData.SurfaceNumber

Return type: int

Property NumberOfDataPoints

Definition:

int ZOSAPI.Editors.LDE.ISTAR_StressFEAData.NumberOfDataPoints

Return type: int

Property Filename

Definition:

string ZOSAPI.Editors.LDE.ISTAR_StressFEAData.Filename

Return type: string

Property Name

Definition:

string ZOSAPI.Editors.LDE.ISTAR_StressFEAData.Name

Return type: string

Property IsStressImported

Definition:

bool ZOSAPI.Editors.LDE.ISTAR_StressFEAData.IsStressImported

Return type: bool

Public functions

Function ImportStress

void ZOSAPI.Editors.LDE.ISTAR_StressFEAData.ImportStress(string filename)

Parameters:

• string filename

Return type: void

Function ImportStress_1

int ZOSAPI.Editors.LDE.ISTAR_StressFEAData.ImportStress_1(string filename)

Import Stress Tensor 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 UnloadData

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

Return type: void

Function UnloadDataAndKeepFiles

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

Return type: void

Function GetFEAPointsSafe

ISTAR_PointWithStress[] ZOSAPI.Editors.LDE.ISTAR_StressFEAData.GetFEAPointsSafe()

Return type: ISTAR_PointWithStress[]

Function GetTransformValues

ICoordinateTransform ZOSAPI.Editors.LDE.ISTAR_StressFEAData.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_PointWithStress[] ZOSAPI.Editors.LDE.ISTAR_StressFEAData.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_PointWithStress[]

Function GetTransformedFEAPointsNoImportRequired

ISTAR_PointWithStress[] ZOSAPI.Editors.LDE.ISTAR_StressFEAData.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 ImportStress 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_PointWithStress[]

Function IsStressTensorApplied

bool ZOSAPI.Editors.LDE.ISTAR_StressFEAData.IsStressTensorApplied()

Return type: bool