Interface ZOSAPI::Tools::Tolerancing::IToleranceNest

Definition:

Interface to access the IToleranceNest Wizard.This interface can be accessed via the IOpticalSystemTools interface.

Usage (see Example 14 for a full sample)

C#

            // Set up the Tolerancing analysis and run it
            ZOSAPI.Tools.Tolerancing.ITolerancing tol = TheSystem.Tools.OpenTolerancing();
            // Select Sensitivity mode
            tol.SetupMode = ZOSAPI.Tools.Tolerancing.SetupModes.Sensitivity;
            // Select Criterion and related settings 
            tol.Criterion = ZOSAPI.Tools.Tolerancing.Criterions.RMSSpotRadius;
            tol.CriterionSampling = 3;
            tol.CriterionComp = ZOSAPI.Tools.Tolerancing.CriterionComps.OptimizeAll_DLS;
            tol.CriterionCycle = 2;
            tol.CriterionField = ZOSAPI.Tools.Tolerancing.CriterionFields.UserDefined;
            // Select the number or MC runs and files to save
            tol.NumberOfRuns = 20;
            tol.NumberToSave = 20;
            // Run the Tolerancing analysis
            tol.RunAndWaitForCompletion();
            tol.Close();

C++

    // Set up the Tolerancing analysis and run it
    ZOSAPI_Interfaces::ITolerancingPtr tol = TheSystem->Tools->OpenTolerancing();
    // Select Sensitivity mode
    tol->SetupMode = ZOSAPI_Interfaces::SetupModes_Sensitivity;
    // Select Criterion and related settings 
    tol->Criterion = ZOSAPI_Interfaces::Criterions_RMSSpotRadius;
    tol->CriterionSampling = 3;
    tol->CriterionComp = ZOSAPI_Interfaces::CriterionComps_OptimizeAll_DLS;
    tol->CriterionCycle = 2;
    tol->CriterionField = ZOSAPI_Interfaces::CriterionFields_UserDefined;
    // Select the number or MC runs and files to save
    tol->NumberOfRuns = 20;
    tol->NumberToSave = 20;
    // Run the Tolerancing analysis
    ZOSAPI_Interfaces::ISystemToolPtr baseTool = tol;
    baseTool->RunAndWaitForCompletion();
    baseTool->Close();

Matlab

    % Set up the Tolerancing analysis and run it
    tol = TheSystem.Tools.OpenTolerancing();
    % Select Sensitivity mode
    tol.SetupMode = ZOSAPI.Tools.Tolerancing.SetupModes.Sensitivity;
    % Select Criterion and related settings 
    tol.Criterion = ZOSAPI.Tools.Tolerancing.Criterions.RMSSpotRadius;
    tol.CriterionSampling = 3;
    tol.CriterionComp = ZOSAPI.Tools.Tolerancing.CriterionComps.OptimizeAll_DLS;
    tol.CriterionCycle = 2;
    tol.CriterionField = ZOSAPI.Tools.Tolerancing.CriterionFields.UserDefined;
    % Select the number or MC runs and files to save
    tol.NumberOfRuns = 20;
    tol.NumberToSave = 20;
    % Run the Tolerancing analysis
    tol.RunAndWaitForCompletion();
    tol.Close();

Python

    # Set up Tolerancing analysis and run it
    tol = TheSystem.Tools.OpenTolerancing()
    # Select Sensitivity mode
    tol.SetupMode =  ZOSAPI.Tools.Tolerancing.SetupModes.Sensitivity
    # Select Criterion and related settings
    tol.Criterion = ZOSAPI.Tools.Tolerancing.Criterions.RMSSpotRadius
    tol.CriterionSampling = 3
    tol.CriterionComp = ZOSAPI.Tools.Tolerancing.CriterionComps.OptimizeAll_DLS
    tol.CriterionCycle = 2
    tol.CriterionField = ZOSAPI.Tools.Tolerancing.CriterionFields.UserDefined
    # Select number of MC runs and files to save
    tol.NumberOfRuns = 20
    tol.NumberToSave = 20
    # Run the Tolerancing analysis
    tol.RunAndWaitForCompletion()
    tol.Close()

Inherits from:

• ZOSAPI.Tools.ISystemTool

Members

• AddGroup
• CanCancel
• Cancel
• Close
• DecenterX
• DecenterY
• DecenterZ
• EndSurf
• ErrorMessage
• IsAsynchronous
• IsFiniteDuration
• IsReferenceToDecenteredApertureValid
• IsRunning
• IsValid
• MPVTOption
• PivotCheck
• PivotX
• PivotY
• PivotZ
• Progress
• Run
• RunAndWaitForCompletion
• RunAndWaitWithTimeout
• StartSurf
• Status
• Succeeded
• TiltX
• TiltY
• TiltZ
• WaitForCompletion
• WaitWithTimeout

Properties

Property MPVTOption

Definition:

MPVTOptions ZOSAPI.Tools.Tolerancing.IToleranceNest.MPVTOption

Return type: MPVTOptions

Property StartSurf

Definition:

int ZOSAPI.Tools.Tolerancing.IToleranceNest.StartSurf

Return type: int

Property EndSurf

Definition:

int ZOSAPI.Tools.Tolerancing.IToleranceNest.EndSurf

Return type: int

Property PivotX

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.PivotX

Return type: double

Property PivotY

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.PivotY

Return type: double

Property PivotZ

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.PivotZ

Return type: double

Property DecenterX

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.DecenterX

Return type: double

Property DecenterY

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.DecenterY

Return type: double

Property DecenterZ

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.DecenterZ

Return type: double

Property TiltX

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.TiltX

Return type: double

Property TiltY

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.TiltY

Return type: double

Property TiltZ

Definition:

double ZOSAPI.Tools.Tolerancing.IToleranceNest.TiltZ

Return type: double

Property PivotCheck

Definition:

bool ZOSAPI.Tools.Tolerancing.IToleranceNest.PivotCheck

Return type: bool

Public functions

Function AddGroup

void ZOSAPI.Tools.Tolerancing.IToleranceNest.AddGroup(int firstSurface, int lastSurface, MPVTOptions mpvtOption, double PivotX, double PivotY, double PivotZ, double DecenterX, double DecenterY, double DecenterZ, double TiltX, double TiltY, double TiltZ, bool PivotCheck)

Parameters:

• int firstSurface
• int lastSurface
• MPVTOptions mpvtOption
• double PivotX
• double PivotY
• double PivotZ
• double DecenterX
• double DecenterY
• double DecenterZ
• double TiltX
• double TiltY
• double TiltZ
• bool PivotCheck

Return type: void

Function IsReferenceToDecenteredApertureValid

bool ZOSAPI.Tools.Tolerancing.IToleranceNest.IsReferenceToDecenteredApertureValid(int firstSurface, int lastSurface)

Parameters:

• int firstSurface
• int lastSurface

Return type: bool