Inheritance diagram for ZOSAPI.Editors.ISolveSurfacePickup:

Public Member Functions
bool	IsPickupFromCurrentColumn ()

void	MakePickupFromCurrentColumn ()

Properties
int	Surface `[get, set]`

double	ScaleFactor `[get, set]`

bool	SupportsScale `[get]`

double	Offset `[get, set]`

bool	SupportsOffset `[get]`

SurfaceColumn	Column `[get, set]`

Properties inherited from ZOSAPI.Editors.ISolveData
bool	IsValid `[get]`
	Gets a value indicating whether the current solve settings are valid.

SolveType	Type `[get]`
	The solve type for this instance.

ISolveNone	_S_None `[get]`

ISolveFixed	_S_Fixed `[get]`

ISolveVariable	_S_Variable `[get]`

ISolveSurfacePickup	_S_SurfacePickup `[get]`

ISolveZPLMacro	_S_ZPLMacro `[get]`

ISolveMarginalRayAngle	_S_MarginalRayAngle `[get]`

ISolveMarginalRayHeight	_S_MarginalRayHeight `[get]`

ISolveChiefRayAngle	_S_ChiefRayAngle `[get]`

ISolveMarginalRayNormal	_S_MarginalRayNormal `[get]`

ISolveChiefRayNormal	_S_ChiefRayNormal `[get]`

ISolveAplanatic	_S_Aplanatic `[get]`

ISolveElementPower	_S_ElementPower `[get]`

ISolveCocentricSurface	_S_CocentricSurface `[get]`

ISolveCocentricRadius	_S_CocentricRadius `[get]`

ISolveFNumber	_S_FNumber `[get]`

ISolveChiefRayHeight	_S_ChiefRayHeight `[get]`

ISolveEdgeThickness	_S_EdgeThickness `[get]`

ISolveOpticalPathDifference	_S_OpticalPathDifference `[get]`

ISolvePosition	_S_Position `[get]`

ISolveCompensator	_S_Compensator `[get]`

ISolveCenterOfCurvature	_S_CenterOfCurvature `[get]`

ISolvePupilPosition	_S_PupilPosition `[get]`

ISolveMaterialModel	_S_MaterialModel `[get]`

ISolveMaterialSubstitute	_S_MaterialSubstitute `[get]`

ISolveMaterialOffset	_S_MaterialOffset `[get]`

ISolveAutomatic	_S_Automatic `[get]`

ISolveMaximum	_S_Maximum `[get]`

ISolvePickupChiefRay	_S_PickupChiefRay `[get]`

ISolveObjectPickup	_S_ObjectPickup `[get]`

ISolveConfigPickup	_S_ConfigPickup `[get]`

ISolveThermalPickup	_S_ThermalPickup `[get]`

ISolveFieldPickup	_S_FieldPickup `[get]`

ISolveDuplicateSag	_S_DuplicateSag `[get]`

ISolveInvertSag	_S_InvertSag `[get]`

Detailed Description

Usage (see Example 15 for a full sample)

C#

            //Thickness 10 pick up from 1
            Solver = Surface10.ThicknessCell.CreateSolveType(ZOSAPI.Editors.SolveType.SurfacePickup);
            ISolveSurfacePickup SolverPickup = Solver._S_SurfacePickup;
            SolverPickup.Surface = 1;
            SolverPickup.ScaleFactor = 1;
            SolverPickup.Column = ZOSAPI.Editors.LDE.SurfaceColumn.Thickness;
            Surface10.ThicknessCell.SetSolveData(Solver);
            SampleFile = System.IO.Path.Combine(TheApplication.SamplesDir, @"API\CS\e15_Seq_Optimization\OptimizedFile3.zos");
            TheSystem.SaveAs(SampleFile);

C++

    // Thickness 10 pick up from 1
    Solver = Surface10->ThicknessCell->CreateSolveType(SolveType::SolveType_SurfacePickup);
    ISolveSurfacePickupPtr SolverPickup = Solver->_S_SurfacePickup;
    SolverPickup->Surface = 1;
    SolverPickup->ScaleFactor = 1;
    SolverPickup->Column = SurfaceColumn::SurfaceColumn_Thickness;
    Surface10->ThicknessCell->SetSolveData(Solver);
    SampleFile = _bstr_t(TheApplication->SamplesDir + "\\API\\CPP\\e15_Seq_Optimization\\OptimizedFile3.zos");
    TheSystem->SaveAs(SampleFile);

Matlab

    %Thickness 10 pick up from 1
    Solver = Surface10.ThicknessCell.CreateSolveType(ZOSAPI.Editors.SolveType.SurfacePickup);
    SolverPickup = Solver.S_SurfacePickup_;
    SolverPickup.Surface = 1;
    SolverPickup.ScaleFactor = 1;
    SolverPickup.Column = ZOSAPI.Editors.LDE.SurfaceColumn.Thickness;
    Surface10.ThicknessCell.SetSolveData(Solver);
    SampleFile = System.String.Concat(TheApplication.SamplesDir, '\API\Matlab\e15_Seq_Optimization\OptimizedFile3.zos');
    TheSystem.SaveAs(SampleFile);

Python

    # Thickness 10 pick up from 1
    Solver = Surface10.ThicknessCell.CreateSolveType(ZOSAPI.Editors.SolveType.SurfacePickup)
    SolverPickup = Solver._S_SurfacePickup
    SolverPickup.Surface = 1
    SolverPickup.ScaleFactor = 1
    SolverPickup.Column = ZOSAPI.Editors.LDE.SurfaceColumn.Thickness
    Surface10.ThicknessCell.SetSolveData(Solver)
    SampleFile = TheApplication.SamplesDir + '\\API\\Python\\e15_Seq_Optimization\\OptimizedFile3.zos'
    TheSystem.SaveAs(SampleFile)

Examples: CSharpStandalone_15_Seq_Optimization.cs.

Member Function Documentation

◆ IsPickupFromCurrentColumn()

bool ZOSAPI.Editors.ISolveSurfacePickup.IsPickupFromCurrentColumn ( )

◆ MakePickupFromCurrentColumn()

void ZOSAPI.Editors.ISolveSurfacePickup.MakePickupFromCurrentColumn ( )

Examples: CSharpStandalone_07_TiltDecenterAndMFOperand.cs.

Property Documentation

◆ Column

SurfaceColumn ZOSAPI.Editors.ISolveSurfacePickup.Column

getset

◆ Offset

double ZOSAPI.Editors.ISolveSurfacePickup.Offset

getset

◆ ScaleFactor

double ZOSAPI.Editors.ISolveSurfacePickup.ScaleFactor

getset

◆ SupportsOffset

bool ZOSAPI.Editors.ISolveSurfacePickup.SupportsOffset

get

◆ SupportsScale

bool ZOSAPI.Editors.ISolveSurfacePickup.SupportsScale

get

◆ Surface

int ZOSAPI.Editors.ISolveSurfacePickup.Surface

getset

ZOS-API interface 2024 R1

ZOSAPI.Editors.ISolveSurfacePickup Interface Reference

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ IsPickupFromCurrentColumn()

◆ MakePickupFromCurrentColumn()

Property Documentation

◆ Column

◆ Offset

◆ ScaleFactor

◆ SupportsOffset

◆ SupportsScale

◆ Surface

Connect with Ansys