Interface ZOSAPI::Editors::LDE::ISurfaceApertureType

Definition:

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)

Inherited by:

• ZOSAPI.Editors.LDE.ISurfaceApertureCircular
• ZOSAPI.Editors.LDE.ISurfaceApertureElliptical
• ZOSAPI.Editors.LDE.ISurfaceApertureFloating
• ZOSAPI.Editors.LDE.ISurfaceApertureNone
• ZOSAPI.Editors.LDE.ISurfaceApertureRectangular
• ZOSAPI.Editors.LDE.ISurfaceApertureSpider
• ZOSAPI.Editors.LDE.ISurfaceApertureUser

Members

• _S_CircularAperture
• _S_CircularObscuration
• _S_EllipticalAperture
• _S_EllipticalObscuration
• _S_FloatingAperture
• _S_None
• _S_RectangularAperture
• _S_RectangularObscuration
• _S_Spider
• _S_UserAperture
• _S_UserObscuration
• IsReadOnly
• Type

Properties

Property Type

Definition:

SurfaceApertureTypes ZOSAPI.Editors.LDE.ISurfaceApertureType.Type

Gets the type.

The type.

Return type: SurfaceApertureTypes

Property IsReadOnly

Definition:

bool ZOSAPI.Editors.LDE.ISurfaceApertureType.IsReadOnly

Return type: bool

Property _S_None

Definition:

ISurfaceApertureNone ZOSAPI.Editors.LDE.ISurfaceApertureType._S_None

Return type: ISurfaceApertureNone

Property _S_CircularAperture

Definition:

ISurfaceApertureCircular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_CircularAperture

Return type: ISurfaceApertureCircular

Property _S_CircularObscuration

Definition:

ISurfaceApertureCircular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_CircularObscuration

Return type: ISurfaceApertureCircular

Property _S_Spider

Definition:

ISurfaceApertureSpider ZOSAPI.Editors.LDE.ISurfaceApertureType._S_Spider

Return type: ISurfaceApertureSpider

Property _S_RectangularAperture

Definition:

ISurfaceApertureRectangular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_RectangularAperture

Return type: ISurfaceApertureRectangular

Property _S_RectangularObscuration

Definition:

ISurfaceApertureRectangular ZOSAPI.Editors.LDE.ISurfaceApertureType._S_RectangularObscuration

Return type: ISurfaceApertureRectangular

Property _S_EllipticalAperture

Definition:

ISurfaceApertureElliptical ZOSAPI.Editors.LDE.ISurfaceApertureType._S_EllipticalAperture

Return type: ISurfaceApertureElliptical

Property _S_EllipticalObscuration

Definition:

ISurfaceApertureElliptical ZOSAPI.Editors.LDE.ISurfaceApertureType._S_EllipticalObscuration

Return type: ISurfaceApertureElliptical

Property _S_UserAperture

Definition:

ISurfaceApertureUser ZOSAPI.Editors.LDE.ISurfaceApertureType._S_UserAperture

Return type: ISurfaceApertureUser

Property _S_UserObscuration

Definition:

ISurfaceApertureUser ZOSAPI.Editors.LDE.ISurfaceApertureType._S_UserObscuration

Return type: ISurfaceApertureUser

Property _S_FloatingAperture

Definition:

ISurfaceApertureFloating ZOSAPI.Editors.LDE.ISurfaceApertureType._S_FloatingAperture

Return type: ISurfaceApertureFloating