Table of Contents

Class Globals

Namespace
VirtualLabAPI.Core.Common
Assembly
VirtualLabAPI.dll

This class stores global settings and holds several programming interfaces.

public static class Globals
Inheritance
Globals
Inherited Members

Fields

AbsoluteZeroInDegreesCelsius

The absolute zero temperature in degrees Celsius.

public const double AbsoluteZeroInDegreesCelsius = -273.15

Field Value

double

DefaultName

Default document name.

public static string DefaultName

Field Value

string

ElectricConstant

Declaration of Electric Field Constant \(\epsilon_0\) in \(\mathrm{\frac{C}{V\cdot m}}\). The electric constant is \(\epsilon_0 =\frac {1}{\mu_0 c^2}\) where \(c\) is the defined value for the vacuum speed of light.

public const double ElectricConstant = 8.854187818789433E-12

Field Value

double

ElementaryCharge

The elementary charge \(e\).

public const double ElementaryCharge = 1.602176634E-19

Field Value

double

Epsilon

Declaration of an epsilon to check whether two values (influenced by numerical errors) are equal. In other words, two values \(a\) and \(b\) are considered as identical if \(b \cdot (1 - \epsilon) \geq a \geq b \cdot (1 + \epsilon)\).

public const double Epsilon = 1E-10

Field Value

double

IdealizedHighAbsorptionCoefficient

The constant absorption coefficient of the idealized high absorption material (mirror material)

public const double IdealizedHighAbsorptionCoefficient = 1000000000000000

Field Value

double

MagneticConstant

Declaration of Magnetic Field Constant \(\mu\) in \(\mathrm{\frac{V\cdot s}{A\cdot m}}\).

public const double MagneticConstant = 1.25663706127E-06

Field Value

double

MaxWavelengthVIS

Maximum wavelength of the visible spectrum

public const double MaxWavelengthVIS = 8.3E-07

Field Value

double

MaximumNumberOfBinaryMasks

The maximum number of binary masks for interface / structure export. Also defines the number of height levels for quantization (2 to the power of this value).

public const int MaximumNumberOfBinaryMasks = 12

Field Value

int

Min2DSamplingPointNumber

Minimum number of sampling points in one axis

public static int Min2DSamplingPointNumber

Field Value

int

MinWavelengthVIS

Minimum wavelength of the visible spectrum

public const double MinWavelengthVIS = 3.6E-07

Field Value

double

PascalsPerAtm

Pascals per atmosphere (= normal pressure in pascals).

public const double PascalsPerAtm = 101325

Field Value

double

PlanckConstant

The Planck constant \(h\).

public const double PlanckConstant = 6.62607015E-34

Field Value

double

SecondRadiationConstant

The second radiation constant \(\frac{hc}{k}\).

public const double SecondRadiationConstant = 0.01438776877

Field Value

double

VacuumSpeedOfLight

Defined value of the speed of light in vacuum \(c\) in \(\mathrm{\frac{m}{s}}\).

public const double VacuumSpeedOfLight = 299792458

Field Value

double

WienDisplacementLawConstant

The constant used in the Wien displacement law constant over wavelength.

public const double WienDisplacementLawConstant = 0.002897771955

Field Value

double

Properties

AssemblyDirectory

Gets the path of the directory in which this VirtualLabAPI.dll is located.

public static string AssemblyDirectory { get; }

Property Value

string

DataDisplay

IDataDisplay object that implements interface which shows new documents in main form and writes into logging window.

public static IDataDisplay DataDisplay { get; set; }

Property Value

IDataDisplay

DefaultColorLookupTables

Gets the color lookup tables to be used as default (one for real part, imaginary part, amplitude, phase and squared amplitude, respectively). This is a copy of the array set in the Global Options dialog.

public static ColorLookUpTableForDataView2D[] DefaultColorLookupTables { get; }

Property Value

ColorLookUpTableForDataView2D[]

Defaults

Gets and sets a collection of default values which can be edited in the Global Options dialog. Setting this property saves the global options to a file which is loaded at he next start of VirtualLab.

public static GlobalOptions Defaults { get; set; }

Property Value

GlobalOptions

ProgrammableDLLSupportPathInternal

public set/get property of path to find API DLL. Only used for the Comparer tests.

public static string ProgrammableDLLSupportPathInternal { get; set; }

Property Value

string

ShowStatusBar

Gets and sets whether the status bar of the main window is visible.

public static bool ShowStatusBar { get; set; }

Property Value

bool

UsePerformanceMonitoring

Gets and sets whether the controls for monitoring CPU and physical memory usage are shown and used.

public static bool UsePerformanceMonitoring { get; set; }

Property Value

bool

UserDataDirectory

Directory containing all user-defined catalogs and log files.

public static string UserDataDirectory { get; set; }

Property Value

string

UserDataDirectoryCurrentVersion

Gets the sub-folder of the user data directory matching the current version. In this folder version specific data like the Global Options are stored.

public static string UserDataDirectoryCurrentVersion { get; }

Property Value

string

ZemaxDir

Path to the user data directory of Zemax.

public static string ZemaxDir { get; set; }

Property Value

string

ZemaxGlassCatalogDir

Gets the path to the Zemax glass catalogs.

public static string ZemaxGlassCatalogDir { get; }

Property Value

string