Skip to main content

ZOS-API interface 2025 R2

ZOSAPI.SystemData.ISystemData Interface Reference

Last update: 16.07.2025

Interfaces and methods for changing all System Explorer data. This interface can be accessed via the IOpticalSystem interface. More...

Properties

ISDApertureData Aperture [get]
 
IWavelengths Wavelengths [get]
 
IFields Fields [get]
 
ISDEnvironmentData Environment [get]
 
ISDPolarizationData Polarization [get]
 
ISDAdvancedData Advanced [get]
 
ISDRayAimingData RayAiming [get]
 
ISDMaterialCatalogData MaterialCatalogs [get]
 
ISDTitleNotes TitleNotes [get]
 
ISDFiles Files [get]
 
ISDUnitsData Units [get]
 
ISDNonSeqData NonSequentialData [get]
 
ISDNamedFilters NamedFiltersData [get]
 

Detailed Description

Interfaces and methods for changing all System Explorer data. This interface can be accessed via the IOpticalSystem interface.

Examples
CSharpStandalone_01_new_file_and_quickfocus.cs, CSharpStandalone_11_Basic_Seq.cs, CSharpStandalone_15_Seq_Optimization.cs, CSharpStandalone_18_SetMulticonfiguration.cs, and CSharpStandalone_19_Surface_Properties.cs.

Property Documentation

◆ Advanced

ISDAdvancedData ZOSAPI.SystemData.ISystemData.Advanced
get

◆ Aperture

ISDApertureData ZOSAPI.SystemData.ISystemData.Aperture
get

◆ Environment

ISDEnvironmentData ZOSAPI.SystemData.ISystemData.Environment
get

◆ Fields

◆ Files

ISDFiles ZOSAPI.SystemData.ISystemData.Files
get

◆ MaterialCatalogs

ISDMaterialCatalogData ZOSAPI.SystemData.ISystemData.MaterialCatalogs
get

◆ NamedFiltersData

ISDNamedFilters ZOSAPI.SystemData.ISystemData.NamedFiltersData
get

◆ NonSequentialData

ISDNonSeqData ZOSAPI.SystemData.ISystemData.NonSequentialData
get

◆ Polarization

ISDPolarizationData ZOSAPI.SystemData.ISystemData.Polarization
get

◆ RayAiming

ISDRayAimingData ZOSAPI.SystemData.ISystemData.RayAiming
get

◆ TitleNotes

ISDTitleNotes ZOSAPI.SystemData.ISystemData.TitleNotes
get

◆ Units

ISDUnitsData ZOSAPI.SystemData.ISystemData.Units
get

Usage (see Example 11 for a full sample)

C#

// Set system lens units to inches, scale all values with Scale Lens tool
// For demonstration only. This file is new, so it has default units mm.
ZemaxSystemUnits unit = TheSystemData.Units.LensUnits;
// Open Scale Lens tool
ScaleLens = TheSystem.Tools.OpenScale();
// Apply Tool Settings
ScaleLens.ScaleByUnits = true;
ScaleLens.ScaleToUnit = ScaleToUnits.Inches;
ScaleLens.RunAndWaitForCompletion();
ScaleLens.Close();
ZemaxSystemUnits
Definition: InterfacesSE.cs:27

C++

// Set system lens units to inches, scale all values with Scale Lens tool
// For demonstration only. This file is new, so it has default units mm.
ZemaxSystemUnits unit = TheSystemData->Units->LensUnits;
// Open Scale Lens tool
IScalePtr ScaleLens = TheSystem->Tools->OpenScale();
// Apply Tool Settings
ScaleLens->ScaleByUnits = true;
ScaleLens->ScaleToUnit = ScaleToUnits_Inches;
ISystemToolPtr baseTool = ScaleLens;
baseTool->RunAndWaitForCompletion();
baseTool->Close();

Matlab

% Set system lens units to inches, scale all values with Scale Lens tool
unit = TheSystemData.Units.LensUnits; % For demonstration only. This file is new, so it has default units mm.
ScaleLens = TheSystem.Tools.OpenScale(); % Open Scale Lens tool
% Apply Tool Settings
ScaleLens.ScaleByUnits = true;
ScaleLens.ScaleToUnit = ZOSAPI.Tools.General.ScaleToUnits.Inches;
ScaleLens.RunAndWaitForCompletion();
ScaleLens.Close();
Definition: Tools.cs:704
Definition: FileSource.cs:4
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

Python

# Set system lens units to inches, scale all values with Scale Lens tool
unit = TheSystemData.Units.LensUnits # For demonstration only. This file is new, so it has default units mm.
ScaleLens = TheSystem.Tools.OpenScale() # Open Scale Lens tool
# Apply Tool Settings
ScaleLens.ScaleByUnits = True
ScaleLens.ScaleToUnit = 2 # 0=millimeters; 1=centimeters; 2=inches; 3=meters
# Cast to ISystemTool interface to gain access to Run
ScaleLens.RunAndWaitForCompletion()
ScaleLens.Close()
Examples
CSharpStandalone_11_Basic_Seq.cs.

◆ Wavelengths

Connect with Ansys