Base interface for settings specific to a SurfaceApertureTypes. This interface can be retrieved from a ILDEApertureData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the appropriate aperture type settings. More...

Inheritance diagram for ZOSAPI.Editors.LDE.ISurfaceApertureType:

[legend]

Properties
SurfaceApertureTypes	Type `[get]`
	Gets the type.

bool	IsReadOnly `[get]`

ISurfaceApertureNone	_S_None `[get]`

ISurfaceApertureCircular	_S_CircularAperture `[get]`

ISurfaceApertureCircular	_S_CircularObscuration `[get]`

ISurfaceApertureSpider	_S_Spider `[get]`

ISurfaceApertureRectangular	_S_RectangularAperture `[get]`

ISurfaceApertureRectangular	_S_RectangularObscuration `[get]`

ISurfaceApertureElliptical	_S_EllipticalAperture `[get]`

ISurfaceApertureElliptical	_S_EllipticalObscuration `[get]`

ISurfaceApertureUser	_S_UserAperture `[get]`

ISurfaceApertureUser	_S_UserObscuration `[get]`

ISurfaceApertureFloating	_S_FloatingAperture `[get]`

Detailed Description

Base interface for settings specific to a SurfaceApertureTypes. This interface can be retrieved from a ILDEApertureData interface. Note that the "_S_" properties are convenience methods for retrieving the derived interface for the appropriate aperture type settings.

Usage (see Example 11 for a full sample)

C#

            // Add Rectangular Aperture to Surface 1
            // Get surface 1, create aperture settings
            Surf_1 = TheSystem.LDE.GetSurfaceAt(1);
            ISurfaceApertureType rAperture = Surf_1.ApertureData.CreateApertureTypeSettings(SurfaceApertureTypes.RectangularAperture);
            // Set aperture size
            rAperture._S_RectangularAperture.XHalfWidth = 0.1;
            rAperture._S_RectangularAperture.YHalfWidth = 0.1;
            // Apply aperture settings to surface 1
            Surf_1.ApertureData.ChangeApertureTypeSettings(rAperture);

C++

    // Add Rectangular Aperture to Surface 1
    // Get surface 1, create aperture settings
    Surf_1 = TheSystem->LDE->GetSurfaceAt(1);
    ISurfaceApertureTypePtr rAperture = Surf_1->ApertureData->CreateApertureTypeSettings(SurfaceApertureTypes_RectangularAperture);
    // Set aperture size
    rAperture->_S_RectangularAperture->XHalfWidth = 0.1;
    rAperture->_S_RectangularAperture->YHalfWidth = 0.1;
    // Apply aperture settings to surface 1
    Surf_1->ApertureData->ChangeApertureTypeSettings(rAperture);

Matlab

    % Add Rectangular Aperture to Surface 1
    % Get surface 1, create aperture settings
    Surf_1 = TheSystem.LDE.GetSurfaceAt(1);
    rAperture = Surf_1.ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture);
    % Set aperture size
    rAperture.S_RectangularAperture_.XHalfWidth = 0.1;
    rAperture.S_RectangularAperture_.YHalfWidth = 0.1;
    % Apply aperture settings to surface 1
    Surf_1.ApertureData.ChangeApertureTypeSettings(rAperture);

Python

    # Add Rectangular Aperture to Surface 1
    # Get surface 1, create aperture settings
    Surf_1 = TheSystem.LDE.GetSurfaceAt(1)
    rAperture = Surf_1.ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture)
    # Set aperture size
    rAperture._S_RectangularAperture.XHalfWidth = .1
    rAperture._S_RectangularAperture.YHalfWidth = .1
    # Apply aperture settings to surface 1
    Surf_1.ApertureData.ChangeApertureTypeSettings(rAperture)

Examples: CSharpStandalone_11_Basic_Seq.cs, and CSharpStandalone_19_Surface_Properties.cs.

Property Documentation

◆ _S_CircularAperture

ISurfaceApertureCircular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_CircularAperture

get

◆ _S_CircularObscuration

ISurfaceApertureCircular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_CircularObscuration

get

◆ _S_EllipticalAperture

ISurfaceApertureElliptical ZOSAPI.Editors.LDE.ISurfaceApertureType._S_EllipticalAperture

get

◆ _S_EllipticalObscuration

ISurfaceApertureElliptical ZOSAPI.Editors.LDE.ISurfaceApertureType._S_EllipticalObscuration

get

◆ _S_FloatingAperture

ISurfaceApertureFloating ZOSAPI.Editors.LDE.ISurfaceApertureType._S_FloatingAperture

get

◆ _S_None

ISurfaceApertureNone ZOSAPI.Editors.LDE.ISurfaceApertureType._S_None

get

◆ _S_RectangularAperture

ISurfaceApertureRectangular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_RectangularAperture

get

◆ _S_RectangularObscuration

ISurfaceApertureRectangular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_RectangularObscuration

get

◆ _S_Spider

ISurfaceApertureSpider ZOSAPI.Editors.LDE.ISurfaceApertureType._S_Spider

get

◆ _S_UserAperture

ISurfaceApertureUser ZOSAPI.Editors.LDE.ISurfaceApertureType._S_UserAperture

get

◆ _S_UserObscuration

ISurfaceApertureUser ZOSAPI.Editors.LDE.ISurfaceApertureType._S_UserObscuration

get

◆ IsReadOnly

bool ZOSAPI.Editors.LDE.ISurfaceApertureType.IsReadOnly

get

◆ Type

SurfaceApertureTypes ZOSAPI.Editors.LDE.ISurfaceApertureType.Type

get

Gets the type.

The type.

ZOS-API interface 2025 R1

ZOSAPI.Editors.LDE.ISurfaceApertureType Interface Reference

Properties