Programming Reference for VirtualLab Fusion  2022.1
Static Public Attributes | Properties | List of all members
Globals Class Reference

This class stores global settings and holds several programming interfaces. More...

Static Public Attributes

const double AbsoluteZeroInDegreesCelsius
 The absolute zero temperature in degrees Celsius.
 
static IActiveDocumentHistory ActiveDocumentHistory
 IActiveDocumentHistory object that implements interface which gets informations about the history of active documents.
 
static IDataDisplay DataDisplay
 
static string DefaultName
 Default document name. More...
 
const double 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.
 
const double ElementaryCharge
 The elementary charge \(e\).
 
const 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)\).
 
const double IdealizedHighAbsorptionCoefficient
 The constant absorption coefficient of the idealized high absorption material (mirror material)
 
const double MagneticConstant
 Declaration of Magnetic Field Constant \(\mu\) in \(\mathrm{\frac{V\cdot s}{A\cdot m}}\).
 
const int 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).
 
const double MaxWavelengthVIS
 Maximum wavelength of the visible spectrum
 
static int Min2DSamplingPointNumber
 Minimum number of sampling points in one axis
 
const double MinWavelengthVIS
 Minimum wavelength of the visible spectrum
 
const double PascalsPerAtm
 Pascals per atmosphere (= normal pressure in pascals).
 
const double PlanckConstant
 The Planck constant \(h\).
 
const double SecondRadiationConstant
 The second radiation constant \(\frac{hc}{k}\).
 
const double VacuumSpeedOfLight
 Defined value of the speed of light in vacuum \(c\) in \(\mathrm{\frac{m}{s}}\).
 
const double WienDisplacementLawConstant
 The constant used in the Wien displacement law constant over wavelength.
 

Properties

static GlobalOptions Defaults [get, set]
 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. More...
 
static string OptiSLangProgramPath [get, set]
 Path to the directory where the optiSLang.exe is located.
 
static string ProgrammableDLLSupportPathInternal [get, set]
 public set/get property of path to find API DLL. Only used for the Comparer tests.
 
static bool ShowStatusBar [get, set]
 Gets and sets whether the status bar of the main window is visible.
 
static string TempDir [get, set]
 Temporary directory to save temporary data during calculations.
 
static bool UsePerformanceMonitoring [get, set]
 Gets and sets whether the controls for monitoring CPU and physical memory usage are shown and used.
 
static string UserDataDirectory [get, set]
 
static string UserDataDirectoryCurrentVersion [get]
 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.
 
static string ZemaxDir [get, set]
 Path to the user data directory of Zemax.
 
static string ZemaxGlassCatalogDir [get]
 Gets the path to the Zemax glass catalogs.
 

Detailed Description

This class stores global settings and holds several programming interfaces.

Member Data Documentation

◆ DataDisplay

IDataDisplay DataDisplay
static

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

◆ DefaultName

string DefaultName
static

Default document name.

Property Documentation

◆ Defaults

GlobalOptions Defaults
staticgetset

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.


◆ UserDataDirectory

string UserDataDirectory
staticgetset

 Directory containing all user-defined catalogs and log files.

 </summary>