System wavelength data. This interface can be accessed via the IWavelengths interface. More...

Public Member Functions
void	MakePrimary ()

Properties
int	WavelengthNumber `[get]`

bool	IsActive `[get]`

bool	IsPrimary `[get]`

double	Wavelength `[get, set]`

double	Weight `[get, set]`

Detailed Description

System wavelength data. This interface can be accessed via the IWavelengths interface.

Member Function Documentation

◆ MakePrimary()

void ZOSAPI.SystemData.IWavelength.MakePrimary ( )

Property Documentation

◆ IsActive

bool ZOSAPI.SystemData.IWavelength.IsActive

get

◆ IsPrimary

bool ZOSAPI.SystemData.IWavelength.IsPrimary

get

◆ Wavelength

double ZOSAPI.SystemData.IWavelength.Wavelength

getset

Usage (see Example 19 for a full sample)

C#

            // ISystemData represents the System Explorer in GUI.
            // We access options in System Explorer through ISystemData in ZOS-API
            ISystemData TheSystemData = TheSystem.SystemData;
            TheSystemData.Aperture.ApertureValue = 10;
            TheSystemData.Aperture.AFocalImageSpace = true;
            TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55;

C++

    // ISystemData represents the System Explorer in GUI.
    // We access options in System Explorer through ISystemData in ZOS-API
    ISystemDataPtr TheSystemData = TheSystem->SystemData;
    TheSystemData->Aperture->ApertureValue = 10;
    TheSystemData->Aperture->AFocalImageSpace = true;
    TheSystemData->Wavelengths->GetWavelength(1)->Wavelength = 0.55;

Matlab

    % ISystemData represents the System Explorer in GUI.
    % We access options in System Explorer through ISystemData in ZOS-API
    TheSystemData = TheSystem.SystemData;
    TheSystemData.Aperture.ApertureValue = 10;
    TheSystemData.Aperture.AFocalImageSpace = true;
    TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55;

Python

    # ISystemData represents the System Explorer in GUI.
    # We access options in System Explorer through ISystemData in ZOS-API
    TheSystemData = TheSystem.SystemData
    TheSystemData.Aperture.ApertureValue = 10
    TheSystemData.Aperture.AFocalImageSpace = True
    TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55

Examples: CSharpStandalone_19_Surface_Properties.cs.

◆ WavelengthNumber

int ZOSAPI.SystemData.IWavelength.WavelengthNumber

get

◆ Weight

double ZOSAPI.SystemData.IWavelength.Weight

getset

ZOS-API interface 2025 R1

ZOSAPI.SystemData.IWavelength Interface Reference

Public Member Functions

Properties