ZOS-API interface 2025 R2

ZOSAPI.Tools.Tolerancing Namespace Reference

Last update: 16.07.2025

Classes

interface  IMonteCarloData
 
interface  IQuickSensitivity
 
interface  ISensitivityCompensator
 
interface  ISensitivityCriterionMetadata
 
interface  ISensitivityData
 
interface  ISensitivityOperandEffect
 
interface  ISensitivityOperandMetadata
 
interface  ITeziData
 
interface  IToleranceDataViewer
 
interface  ITolerancing
 Interfaces and methods for running Tolerancing. This interface can be accessed via the IOpticalSystemTools interface. More...
 
interface  ITolerancingColumnMetadata
 
interface  ITolerancingHistogram
 
interface  ITolerancingOperandMetadata
 
interface  ITolerancingParameter
 
interface  ITolerancingSummaryStatistics
 

Enumerations

enum  SetupModes { Sensitivity = 0 , InverseLimit , InverseIncrement , SkipSensitivity }
 Tolerancing Tool 'Setup' Modes. More...
 
enum  SetupPolynomials { None = 0 , ThreeMinusTerm , FiveMinusTerm }
 Tolerancing Tool 'Setup' Polynomials. More...
 
enum  SetupCaches { RecomputeAll = 0 , RecomputeChanged , UsePolynomial }
 Tolerancing Tool 'Setup' Caches. More...
 
enum  SetupChanges { LinearDifference = 0 , RSSDifference }
 Tolerancing Tool 'Setup' Changes. More...
 
enum  Criterions {
  NONSEQMeritFunction = 0 , NONSEQUserScript , RMSSpotRadius = 0 , RMSSpotX ,
  RMSSpotY , RMSWavefront , MeritFunction , GeometricMTFAverage ,
  GeometricMTFTan , GeometricMTFSag , DiffMTFAverage , DiffMTFTan ,
  DiffMTFSag , BoresightError , RMSAngularRadius , RMSAngularX ,
  RMSAngularY , UserScript
}
 Tolerancing Tool 'Criterion'. More...
 
enum  CriterionComps {
  NONSEQOptimizeAll = 0 , NONSEQNone , NONSEQOptimizeAll_OD , OptimizeAll_DLS = 0 ,
  ParaxialFocus , None , OptimizeAll_OD
}
 Tolerancing Tool 'Criterion' Comps. More...
 
enum  CriterionFields { NONSEQUserDefined = 0 , Y_Symmetric = 0 , XY_Symmetric , UserDefined }
 Tolerancing Tool 'Criterion' Fields. More...
 
enum  MonteCarloStatistics { Normal = 0 , Uniform , Parabolic }
 Tolerancing Tool 'Monte Carlo' Statistics. More...
 
enum  QSCriterions {
  RMSSpotRadius = 0 , RMSSpotX = 1 , RMSSpotY = 2 , RMSWavefront = 3 ,
  BoresightError = 4 , RMSAngularRadius = 5 , RMSAngularX = 6 , RMSAngularY = 7
}
 
enum  TolerancingParameterName {
  Undefined = -1 , AdjustSurface = 20572 , Code = 20578 , CommentField = 20004 ,
  CompensatorSetting = 11400 , ConfigurationNumber = 16304 , ConfigurationParameter = 20580 , Data = 20586 ,
  FieldNumber = 20683 , FieldSetting = 50027 , Layer = 20574 , MaximumNumber = 20576 ,
  MaximumValue = 20569 , MinimumNumber = 20577 , MinimumValue = 20568 , NominalValue = 20566 ,
  Object = 20585 , ParameterNumber = 20573 , RowNumber = 20579 , SamplingSetting = 20694 ,
  Surface = 20567 , Surface1 = 20570 , Surface2 = 20571 , TdeRowNumber = 75418 ,
  Units = 20874 , Statistics = 20875 , PivotPointOption = 20876
}
 
enum  TolerancingColumnName {
  Unknown = -1 , BackFocusChange = 75417 , BoresightError = 11971 , MtfDiffractionAverage = 11968 ,
  MtfDiffractionSagittal = 11970 , MtfDiffractionTangential = 11969 , MtfGeometricAverage = 11965 , MtfGeometricSaggital = 11967 ,
  MtfGeometricTangential = 11966 , RmsAngularRadius = 11972 , RmsAngularX = 11973 , RmsAngularY = 11974 ,
  RmsSpotRadius = 11961 , RmsSpotX = 11962 , RmsSpotY = 11963 , RmsWavefrontError = 11964 ,
  UserMeritFunction = 11959 , UserScript = 11960
}
 
enum  TolerancingOperand {
  Unknown = -1 , CEDV = 32 , CMCO = 33 , CNPA = 47 ,
  CNPS = 48 , COMM = 42 , COMP = 30 , CPAR = 31 ,
  NULL = 0 , SAVE = 29 , SEED = 41 , STAT = 34 ,
  TABB = 27 , TCEO = 45 , TCIO = 44 , TCMU = 40 ,
  TCON = 5 , TCUR = 2 , TEDV = 15 , TEDX = 16 ,
  TEDY = 17 , TEDR = 55 , TETX = 18 , TETY = 19 ,
  TETZ = 20 , TEXI = 28 , TEZI = 39 , TFRN = 3 ,
  TIND = 26 , TIRR = 13 , TIRX = 11 , TIRY = 12 ,
  TMCO = 38 , TNMA = 46 , TNPA = 37 , TNPS = 36 ,
  TPAI = 43 , TPAR = 14 , TRAD = 1 , TSDI = 6 ,
  TSDX = 7 , TSDY = 8 , TSDR = 56 , TSTX = 9 ,
  TSTY = 10 , TTHI = 4 , TUDX = 21 , TUDY = 22 ,
  TUTX = 23 , TUTY = 24 , TUTZ = 25 , TWAV = 35 ,
  TRLX = 49 , TRLY = 50 , TRLR = 51 , TARX = 52 ,
  TARY = 53 , TARR = 54 , ISOA = 57 , ISOB = 58 ,
  ISOC = 59 , ISOD = 60 , MPVT = 61
}
 

Enumeration Type Documentation

◆ CriterionComps

enum ZOSAPI.Tools.Tolerancing.CriterionComps

Tolerancing Tool 'Criterion' Comps.

Enumerator
NONSEQOptimizeAll 
NONSEQNone 
NONSEQOptimizeAll_OD 
OptimizeAll_DLS 
ParaxialFocus 
None 
OptimizeAll_OD 

◆ CriterionFields

enum ZOSAPI.Tools.Tolerancing.CriterionFields

Tolerancing Tool 'Criterion' Fields.

Enumerator
NONSEQUserDefined 
Y_Symmetric 
XY_Symmetric 
UserDefined 

◆ Criterions

enum ZOSAPI.Tools.Tolerancing.Criterions

Tolerancing Tool 'Criterion'.

Enumerator
NONSEQMeritFunction 
NONSEQUserScript 
RMSSpotRadius 
RMSSpotX 
RMSSpotY 
RMSWavefront 
MeritFunction 
GeometricMTFAverage 
GeometricMTFTan 
GeometricMTFSag 
DiffMTFAverage 
DiffMTFTan 
DiffMTFSag 
BoresightError 
RMSAngularRadius 
RMSAngularX 
RMSAngularY 
UserScript 

◆ MonteCarloStatistics

enum ZOSAPI.Tools.Tolerancing.MonteCarloStatistics

Tolerancing Tool 'Monte Carlo' Statistics.

Enumerator
Normal 
Uniform 
Parabolic 

◆ QSCriterions

enum ZOSAPI.Tools.Tolerancing.QSCriterions
Enumerator
RMSSpotRadius 
RMSSpotX 
RMSSpotY 
RMSWavefront 
BoresightError 
RMSAngularRadius 
RMSAngularX 
RMSAngularY 

◆ SetupCaches

enum ZOSAPI.Tools.Tolerancing.SetupCaches

Tolerancing Tool 'Setup' Caches.

Enumerator
RecomputeAll 
RecomputeChanged 
UsePolynomial 

◆ SetupChanges

enum ZOSAPI.Tools.Tolerancing.SetupChanges

Tolerancing Tool 'Setup' Changes.

Enumerator
LinearDifference 
RSSDifference 

◆ SetupModes

enum ZOSAPI.Tools.Tolerancing.SetupModes

Tolerancing Tool 'Setup' Modes.

Enumerator
Sensitivity 
InverseLimit 
InverseIncrement 
SkipSensitivity 

◆ SetupPolynomials

enum ZOSAPI.Tools.Tolerancing.SetupPolynomials

Tolerancing Tool 'Setup' Polynomials.

Enumerator
None 
ThreeMinusTerm 
FiveMinusTerm 

◆ TolerancingColumnName

enum ZOSAPI.Tools.Tolerancing.TolerancingColumnName
Enumerator
Unknown 

Indicates either that the column is named after an operand or that the name of the column is unknown.

BackFocusChange 
BoresightError 
MtfDiffractionAverage 
MtfDiffractionSagittal 
MtfDiffractionTangential 
MtfGeometricAverage 
MtfGeometricSaggital 
MtfGeometricTangential 
RmsAngularRadius 
RmsAngularX 
RmsAngularY 
RmsSpotRadius 
RmsSpotX 
RmsSpotY 
RmsWavefrontError 
UserMeritFunction 
UserScript 

◆ TolerancingOperand

enum ZOSAPI.Tools.Tolerancing.TolerancingOperand
Enumerator
Unknown 
CEDV 
CMCO 
CNPA 
CNPS 
COMM 
COMP 
CPAR 
NULL 
SAVE 
SEED 
STAT 
TABB 
TCEO 
TCIO 
TCMU 
TCON 
TCUR 
TEDV 
TEDX 
TEDY 
TEDR 
TETX 
TETY 
TETZ 
TEXI 
TEZI 
TFRN 
TIND 
TIRR 
TIRX 
TIRY 
TMCO 
TNMA 
TNPA 
TNPS 
TPAI 
TPAR 
TRAD 
TSDI 
TSDX 
TSDY 
TSDR 
TSTX 
TSTY 
TTHI 
TUDX 
TUDY 
TUTX 
TUTY 
TUTZ 
TWAV 
TRLX 
TRLY 
TRLR 
TARX 
TARY 
TARR 
ISOA 
ISOB 
ISOC 
ISOD 
MPVT 

◆ TolerancingParameterName

enum ZOSAPI.Tools.Tolerancing.TolerancingParameterName
Enumerator
Undefined 
AdjustSurface 
Code 
CommentField 
CompensatorSetting 
ConfigurationNumber 
ConfigurationParameter 
Data 
FieldNumber 
FieldSetting 
Layer 
MaximumNumber 
MaximumValue 
MinimumNumber 
MinimumValue 
NominalValue 
Object 
ParameterNumber 
RowNumber 
SamplingSetting 
Surface 
Surface1 
Surface2 
TdeRowNumber 
Units 
Statistics 
PivotPointOption 

Connect with Ansys