Table of Contents

Class GlobalOptions

Namespace
VirtualLabAPI.Core.Common
Assembly
VirtualLabAPI.dll

This class stores all properties which can be set in the Global Options dialog.

[Serializable]
public class GlobalOptions : ManualSerialization, ISerializable, IDeserializationCallback, IEquatable<IObjectBase>, ICloneable
Inheritance
ObjectBase
SerializableObjectBase
ManualSerialization
GlobalOptions
Implements
IEquatable<IObjectBase>
Inherited Members
Extension Methods

Constructors

GlobalOptions()

Default constructor initializing a new instance of the GlobalOptions class.

public GlobalOptions()

Properties

AirPressureInPascals

The default air pressure, measured in pascals.

public double AirPressureInPascals { get; set; }

Property Value

double

ArtifactsThreshold

Default relative threshold for hiding phase artifacts.

public double ArtifactsThreshold { get; set; }

Property Value

double

AutoCompleteBraces

Gets and sets whether for opening braces and quotation marks the closing character should be added automatically.

public bool AutoCompleteBraces { get; set; }

Property Value

bool

AutomaticRenamingOfHomogenousMedium

In case a homogeneous medium has been edited, a new name may be better. If this flag is set to 'false', the user will be asked every time the medium's suggested name is different than the actual one.

public bool AutomaticRenamingOfHomogenousMedium { get; set; }

Property Value

bool

AutomaticResamplingForOperations

Gets and sets whether automatic resampling is done in binary operations like addition or multiplication of fields.

public bool AutomaticResamplingForOperations { get; set; }

Property Value

bool

AutomaticSaving

Gets and sets whether files shall be saved automatically

public bool AutomaticSaving { get; set; }

Property Value

bool

AutomaticSavingInterval

Gets and sets the interval for automatic saving in seconds.

public double AutomaticSavingInterval { get; set; }

Property Value

double

AxisFontSize

Gets and sets the default font size of axes for 1D and 2D diagrams.

public float AxisFontSize { get; set; }

Property Value

float

ColorLookupTables

Gets and sets the color lookup tables to be used as default for real part, imaginary part, amplitude, phase and squared amplitude. Use this property only in the Global Options dialog! In normal case, use Globals.DefaultColorLookupTables, which return a copy of this array.

public ColorLookUpTableForDataView2D[] ColorLookupTables { get; set; }

Property Value

ColorLookUpTableForDataView2D[]

ColorSystem

Color system to be used for transforming CIEXYZ to RGB.

public Colorsystem ColorSystem { get; set; }

Property Value

Colorsystem

ColorTableForDetectors

Gets and sets the default color table for detectors.

public ColorLookUpTableForDataView2D ColorTableForDetectors { get; set; }

Property Value

ColorLookUpTableForDataView2D

ColorUndefinedData_1D

A color used to indicate undefined values in 1D displays.

public Color ColorUndefinedData_1D { get; set; }

Property Value

Color

ColorUndefinedData_2D

A color used to indicate undefined values in 2D displays.

public Color ColorUndefinedData_2D { get; set; }

Property Value

Color

CopyPasteOfLPEcopiesAbsPosAsWell

In case an Optical Setup Element has been copied and pasted via clipboard, the user may decide whether or not the absolute position shall be copied as well or to re-set the position and orientation to 'Undefined' (). If this flag is set to 'false', the pasted element's position and orientation will always be reset to undefined. If this flag is set to 'true', the pasted element's position and orientation will always be copied from its source. If this flag is set to 'null', the user will be asked.

public bool? CopyPasteOfLPEcopiesAbsPosAsWell { get; set; }

Property Value

bool?

DefaultFilePath

Gets the default file path used when the user has not yet set an own file path.

public static string DefaultFilePath { get; }

Property Value

string

DefaultLoggingLevelSimulation

public property to set and get the default logging level for simulation

public LogDetailLevel DefaultLoggingLevelSimulation { get; set; }

Property Value

LogDetailLevel

DefaultRotationAxisForInitialAxisRotationSequence

Which kind of axis rotation sequence shall represent a non-rotation? It consists of one single rotation with angle 0, but about which axis? The same axis will be used as initial singular entry within a new axis rotation sequence.

public AxisDirection DefaultRotationAxisForInitialAxisRotationSequence { get; set; }

Property Value

AxisDirection

DeviationThreshold

Deviation Threshold as used by several propagation operators.

public double DeviationThreshold { get; set; }

Property Value

double

DisplayDurationOfToolTips

Gets and sets the time in seconds a tool tip is usually displayed (some tool tips with much text are set to longer durations).

public double DisplayDurationOfToolTips { get; set; }

Property Value

double

DisplayDurationOfToolTipsInMilliseconds

Gets the time in milliseconds a tool tip is usually displayed (some tool tips with much text are set to longer durations).

public int DisplayDurationOfToolTipsInMilliseconds { get; }

Property Value

int

DuplicationStateForDataArray1D

Gets and sets the default state for manipulating objects of type DataArray1D. This determines whether the data array has to be duplicated, manipulated itself or whether the user has to be asked every time.

public DefaultDocumentDuplicationState DuplicationStateForDataArray1D { get; set; }

Property Value

DefaultDocumentDuplicationState

DuplicationStateForDataArray2D

Gets and sets the default state for manipulating objects of type DataArray2D. This determines whether the data array has to be duplicated, manipulated itself or whether the user has to be asked every time.

public DefaultDocumentDuplicationState DuplicationStateForDataArray2D { get; set; }

Property Value

DefaultDocumentDuplicationState

EmbeddingFrame

VirtualLab embeds (source) fields into a larger field with a frame of zeros. This property defines the width of this frame in pixels. The default value is 10.

public int EmbeddingFrame { get; set; }

Property Value

int

EmbeddingMaterial

Default embedding material.

public Material EmbeddingMaterial { get; set; }

Property Value

Material

EnableLoggingAutomaticOperator

Enables the logging for the automatic propagation operator into message window. This setting only has an effect for the processing of Light Path Elements.

public bool EnableLoggingAutomaticOperator { get; set; }

Property Value

bool

ExpertMode

Shall non-numerical data arrays start in expert mode by default?

public bool ExpertMode { get; set; }

Property Value

bool

FieldComponentsForDetectors

Gets and sets which field components are calculated by default for certain detectors (currently Camera Detector, Electromagnetic Field Detector, PSF & MTF, Power).

public HarmonicFieldComponents[] FieldComponentsForDetectors { get; set; }

Property Value

HarmonicFieldComponents[]

FieldSize

Gets the default field size in meters for newly generated fields.

public VectorD FieldSize { get; }

Property Value

VectorD

FieldSizeFactor

Gets and sets the default oversampling factor.

public double FieldSizeFactor { get; set; }

Property Value

double

FieldSizeLimitForAlgorithmsGiB

Gets and sets the maximum size of a field (in gibibytes) for memory intensive algorithms. If this limit is exceeded, another less memory intensive algorithm is used. Affects Automatic Selection Operator and automatic Fourier transform selection.

public double FieldSizeLimitForAlgorithmsGiB { get; set; }

Property Value

double

FieldSizeTruncationFactor

This ratio decides whether the target field size of the Accelerated Sinc interpolation justifies field truncation in the sinc interpolation step.

public double FieldSizeTruncationFactor { get; set; }

Property Value

double

FileExtension

Gets the file extension used to save an instance of a savable object.

public string FileExtension { get; }

Property Value

string

FormatOfComplexNumbers

Gets and sets how complex numbers are formatted as strings.

public ComplexToStringConversionFormat FormatOfComplexNumbers { get; set; }

Property Value

ComplexToStringConversionFormat

FormatOfPhysicalValues

Gets and sets the format of physical values (Standard, Scientific or Engineering; null means automatic selection).

public AxisNumberFormat? FormatOfPhysicalValues { get; set; }

Property Value

AxisNumberFormat?

FreespaceParametersComponents

public property to set and get the free space parameter to use for propagation to/inside components

public I2OParameters FreespaceParametersComponents { get; set; }

Property Value

I2OParameters

FreespaceParametersDetectors

public property to set and get the free space parameters to use for propagation to detectors

public I2OParameters FreespaceParametersDetectors { get; set; }

Property Value

I2OParameters

GUI_Font

Gets and sets the font generally used in the VirtualLab Graphical User Interface. The get-branch returns a copy of the actual font object, as assigning a font reference to e.g. a label and disposing the label afterwards destroys the font and thus the VirtualLab GUI.

public Font GUI_Font { get; set; }

Property Value

Font

HideNumericalArtifacts

Shall the phase values with vanishing amplitudes (below ArtifactsThreshold) be hidden in the view?

public bool HideNumericalArtifacts { get; set; }

Property Value

bool

InitialWindowSize

Default client size for result document windows (harmonic fields, harmonic fields set, diagrams, data arrays and derived objects).

public Size InitialWindowSize { get; set; }

Property Value

Size

InitializationOfDataArray1DwithAngularDependency

Initialization mode for 1D data arrays with angular dependency.

public ControlDataArray1DWithTable.InitializationOfDataArray1DwithAngularDependency InitializationOfDataArray1DwithAngularDependency { get; set; }

Property Value

ControlDataArray1DWithTable.InitializationOfDataArray1DwithAngularDependency

Internet

Gets and sets the options for the Internet connection.

public InternetOptions Internet { get; set; }

Property Value

InternetOptions

InterpolationMethodForRealValuedSmoothing_Equidistant

The interpolation method to be used for real valued smoothing of views (ViewInterpolationMode.RealValuedSmoothing) in equidistant case.

public InterpolationMethod InterpolationMethodForRealValuedSmoothing_Equidistant { get; }

Property Value

InterpolationMethod

InterpolationMethodForRealValuedSmoothing_NonEquidistant

The interpolation method to be used for real valued smoothing of views (ViewInterpolationMode.RealValuedSmoothing) in non-equidistant case.

public InterpolationMethodForNonequidistantData InterpolationMethodForRealValuedSmoothing_NonEquidistant { get; }

Property Value

InterpolationMethodForNonequidistantData

KeepMediaWavelengthsConstantIfEnvironmentChanges

If true then all wavelengths of lights sources in a light path whose temperature or pressure have been changed will be adapted in a way, keeping the media wavelengths constant. Otherwise the vacuum wavelengths will be kept constant.

public bool KeepMediaWavelengthsConstantIfEnvironmentChanges { get; set; }

Property Value

bool

LengthUnit

Gets and sets the default length unit which is used if a pure double value is to be parsed into a length.

public LengthUnits LengthUnit { get; set; }

Property Value

LengthUnits

LineColor_SingleGraphMode

Gets and sets the color of graph lines (in singlegraph mode) to be used as default.

public Color LineColor_SingleGraphMode { get; set; }

Property Value

Color

LineColor_SingleGraphMode_Polar

Gets and sets the color of graph lines (in singlegraph mode) to be used as default.

public Color LineColor_SingleGraphMode_Polar { get; set; }

Property Value

Color

LineThickness

Gets and sets the thickness of graph lines to be used as default.

public float LineThickness { get; set; }

Property Value

float

ListOfColorLookupTables_forMenu

List of those color lookup tables which appear in the menu to select the current lookup table from

public List<ColorLookUpTableForDataView2D> ListOfColorLookupTables_forMenu { get; set; }

Property Value

List<ColorLookUpTableForDataView2D>

ListOfPropertiesUsedForInitializationAsPolarDiagram

List of physical properties for which 1D data arrays with angular coordinates are initially shown as polar diagrams.

public List<PhysicalProperty> ListOfPropertiesUsedForInitializationAsPolarDiagram { get; set; }

Property Value

List<PhysicalProperty>

MainWindowTheme

Gets and sets the theme currently applied to the main window.

public Themes MainWindowTheme { get; set; }

Property Value

Themes

MarkerLineThickness_1DViews

Gets and sets the thickness of the lines which are used for drawing markers in 1D diagrams.

public float MarkerLineThickness_1DViews { get; set; }

Property Value

float

MarkerLineThickness_2DViews

Gets and sets the thickness of the lines which are used for drawing markers in 2D diagrams.

public float MarkerLineThickness_2DViews { get; set; }

Property Value

float

MaxFieldMembersWarningLevel

Maximal number of HarmonicFieldsSet members which will be accepted without warning dialog at source field generation.

public double MaxFieldMembersWarningLevel { get; set; }

Property Value

double

MaximumNumberOfRaysThatAllowsSnapping

Maximum number of rays that allow snapping inside the view of a ray distribution.

public int MaximumNumberOfRaysThatAllowsSnapping { get; set; }

Property Value

int

MaximumNumberOfSnapshotFiles

Gets and sets the maximum number of snapshot files stored per document.

public int MaximumNumberOfSnapshotFiles { get; set; }

Property Value

int

MaximumNumberOfTableCellsForDataArrays

Maximum number of table cells that will be displayed in a data array 2D table.

public int MaximumNumberOfTableCellsForDataArrays { get; set; }

Property Value

int

MinAmountOfAvailablePhysicalMemoryWarningLevel

Gets and sets the minimal amount of available physical memory in gibibytes which will be accepted without warning dialog while allocating memory.

public double MinAmountOfAvailablePhysicalMemoryWarningLevel { get; set; }

Property Value

double

MinAmountOfAvailablePhysicalMemoryWarningLevelBytes

Gets and sets the minimal amount of available physical memory in bytes which will be accepted without warning dialog while allocating memory.

public double MinAmountOfAvailablePhysicalMemoryWarningLevelBytes { get; set; }

Property Value

double

NotifyIconMode

Gets and sets when the notify icon and notifications are visible.

public NotifyIconVisibility NotifyIconMode { get; set; }

Property Value

NotifyIconVisibility

NumberOfCoresToUse

Gets or sets the number of threads to use (= "Numbers of Cores to Use" on the Performance tab of the Global Options dialog).

public int NumberOfCoresToUse { get; set; }

Property Value

int

NumberOfCoresToUseParameterRun

Gets and sets the number of parallel iterations (for Parameter Run).

public int NumberOfCoresToUseParameterRun { get; set; }

Property Value

int

NumberOfDigits

Number of digits to be shown in numerical strings.

public int NumberOfDigits { get; set; }

Property Value

int

NumberOfDigitsForColorLegend

Number of digits to be shown in the labels of the color legend.

public int NumberOfDigitsForColorLegend { get; set; }

Property Value

int

OrientationDefinitionType

Get or set the default definition type for orientations.

public OrientationDefinitionType OrientationDefinitionType { get; set; }

Property Value

OrientationDefinitionType

OversamplingFactor

Gets and sets the default oversampling factor.

public double OversamplingFactor { get; set; }

Property Value

double

PerformantFastIterations

Gets and sets whether a special performance optimization is done for very fast iterations of a “for” loop (≲ 0.1 seconds execution time).

public bool PerformantFastIterations { get; set; }

Property Value

bool

PolarizationPlane

Gets the polarization plane to be shown by default.

public CombinedComponent PolarizationPlane { get; set; }

Property Value

CombinedComponent

PopUpErrorMessages

Determines whether error messages are shown as separate message boxes in addition to being logged in the Messages tab.

public bool PopUpErrorMessages { get; set; }

Property Value

bool

PopUpWarningMessages

Determines whether warning messages are shown as separate message boxes in addition to being logged in the Messages tab.

public bool PopUpWarningMessages { get; set; }

Property Value

bool

PowerPortionFieldSizeEstimation

The value for automatic detection of the field size.

public double PowerPortionFieldSizeEstimation { get; set; }

Property Value

double

PropagationEngineLPD

public property to set and get the default propagation engine (used for starter toolbox)

public PropagationEngine PropagationEngineLPD { get; }

Property Value

PropagationEngine

PropagationMethodForLinkages

Gets and sets the default propagation technique which shall be used for new linkages.

public HomogeneousMediumPropagationOperator PropagationMethodForLinkages { get; set; }

Property Value

HomogeneousMediumPropagationOperator

RadialAxisColor_primary

Gets and sets the color of the primary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.

public Color RadialAxisColor_primary { get; set; }

Property Value

Color

RadialAxisColor_quaternary

Gets and sets the color of the quaternary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.

public Color RadialAxisColor_quaternary { get; set; }

Property Value

Color

RadialAxisColor_secondary

Gets and sets the color of the secondary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.

public Color RadialAxisColor_secondary { get; set; }

Property Value

Color

RadialAxisColor_tertiary

Gets and sets the color of the tertiary radial axis and its associated graphs in multigraph mode of polar diagram to be used as default.

public Color RadialAxisColor_tertiary { get; set; }

Property Value

Color

RelativeEdgeWidth

VirtualLab uses smooth edges for defining the aperture. The width of the edges is defined as relative value with respect to the field size. The default value is 0.1 (10 percent).

public double RelativeEdgeWidth { get; set; }

Property Value

double

SamplingDistance

Gets and sets the default sampling distance in meters for newly generated fields.

public VectorD SamplingDistance { get; set; }

Property Value

VectorD

SamplingPoints

Gets and sets the default number of sampling points for newly generated fields.

public Vector SamplingPoints { get; set; }

Property Value

Vector

ScalingPolarizationGrid

Default scaling of the polarization grid

public double ScalingPolarizationGrid { get; set; }

Property Value

double

Settings3DView

Gets and sets the default view settings for the 3D view.

public ViewSettings3DView Settings3DView { get; set; }

Property Value

ViewSettings3DView

ShowLegend

Sets and gets whether the legend shall be shown by default.

public bool ShowLegend { get; set; }

Property Value

bool

ShowMinimap

Gets and sets whether a minimap (extended scrollbar) is shown to the right.

public bool ShowMinimap { get; set; }

Property Value

bool

ShowPolarization

Gets and sets whether the polarization shall be shown.

public bool ShowPolarization { get; set; }

Property Value

bool

ShowPolarizationArrows

shall the arrows of the polarization ellipses be shown

public bool ShowPolarizationArrows { get; set; }

Property Value

bool

ShowPolarizationGrid

shall the polarization Grid be shown

public bool ShowPolarizationGrid { get; set; }

Property Value

bool

SourceCodeEditorTheme

Gets and sets whether the source code editor shall use a dark mode or the normal bright mode.

public PredefinedCodeEditorTheme SourceCodeEditorTheme { get; set; }

Property Value

PredefinedCodeEditorTheme

StoreSnapshotFiles

Gets and sets whether snapshot files are generated every time a document changes.

public bool StoreSnapshotFiles { get; set; }

Property Value

bool

SymbolColor_Polar_SingleGraphMode

Gets and sets the color of graph symbols (in singlegraph mode of polar diagram) to be used as default

public Color SymbolColor_Polar_SingleGraphMode { get; set; }

Property Value

Color

SymbolColor_SingleGraphMode

Gets and sets the color of graph symbols (in singlegraph mode) to be used as default

public Color SymbolColor_SingleGraphMode { get; set; }

Property Value

Color

SymbolScalingFactor

Gets and sets the scaling factor of graph symbols to be used as default.

public float SymbolScalingFactor { get; set; }

Property Value

float

SymbolShape_MultiGraphMode

Gets and sets the shape of graph symbols (in multigraph mode) to be used as default. Different symbol shapes will be used not before all colors are used for different subsets.

public DiagramSymbolShape SymbolShape_MultiGraphMode { get; set; }

Property Value

DiagramSymbolShape

SymbolShape_Polar_MultiGraphMode

Gets and sets the shape of graph symbols (in multigraph mode of polar diagram) to be used as default. Different symbol shapes will be used not before all colors are used for different subsets.

public DiagramSymbolShape SymbolShape_Polar_MultiGraphMode { get; set; }

Property Value

DiagramSymbolShape

SymbolShape_Polar_SingleGraphMode

Gets and sets the shape of graph symbols (in singlegraph mode of polar diagram) to be used as default.

public DiagramSymbolShape SymbolShape_Polar_SingleGraphMode { get; set; }

Property Value

DiagramSymbolShape

SymbolShape_SingleGraphMode

Gets and sets the shape of graph symbols (in singlegraph mode) to be used as default.

public DiagramSymbolShape SymbolShape_SingleGraphMode { get; set; }

Property Value

DiagramSymbolShape

SystemTemperatureInDegreesCelsius

The default system temperature, measured in degrees Celsius.

public double SystemTemperatureInDegreesCelsius { get; set; }

Property Value

double

TitleFontSize

Gets and sets the default font size of diagram titles for 2D diagrams.

public float TitleFontSize { get; set; }

Property Value

float

TypeAbbreviationPosition

Gets and sets the position of the type abbreviation of an Optical Setup Element relative to their parent node in the Optical Setup View.

public TypeAbbreviationPositionEnum TypeAbbreviationPosition { get; set; }

Property Value

TypeAbbreviationPositionEnum

UseComponentCSforStackPreview

Gets and sets whether the stack preview uses the coordinate system of the parent component. In this case the preview is rotated and flipped as needed. Otherwise always the stack coordinate system is used, which means that interfaces run from left to right.

public bool UseComponentCSforStackPreview { get; set; }

Property Value

bool

UseEmbeddingForOperations

Gets and sets whether an embedding is to be used for Field * Transmission Operations.

public bool UseEmbeddingForOperations { get; set; }

Property Value

bool

UseIndicatorForHiddenDigitsInPhysicalUnitTextbox

Shall physicalUnitTextBoxes indicate that some digits where hidden due to rounding?

public bool UseIndicatorForHiddenDigitsInPhysicalUnitTextbox { get; set; }

Property Value

bool

UseMKL_FFT

Gets or sets whether the Intel MKL library shall be used for FFT. Otherwise LightTrans FFT is used.

public bool UseMKL_FFT { get; set; }

Property Value

bool

UseMaxFieldMembersAsWarningLevel

Gets and sets whether a maximal number of HFS members is used as warning level MaxFieldMembersWarningLevel will be used as upper limit.

public bool UseMaxFieldMembersAsWarningLevel { get; set; }

Property Value

bool

UseMinAmountOfAvailablePhysicalMemoryWarningAsLevel

Gets and sets whether a minimum amount of available physical memory is used as warning level. MinAmountOfAvailablePhysicalMemoryWarningLevel will be used as lower limit.

public bool UseMinAmountOfAvailablePhysicalMemoryWarningAsLevel { get; set; }

Property Value

bool

UseMultipleCores

Gets or sets a value indicating whether to use multiple cores for calculations.

public bool UseMultipleCores { get; set; }

Property Value

bool

UseOrthogonalLinkagesInOpticalSetupView

Gets and sets whether the linkages of an Optical Setup are drawn in the flowchart with orthogonal (true) or straight (false) connector lines.

public bool UseOrthogonalLinkagesInOpticalSetupView { get; set; }

Property Value

bool

UseRecommendedFont

Gets and sets whether a preset font is used (true) or whether the user configures the font individually (false).

public bool UseRecommendedFont { get; set; }

Property Value

bool

UseSmoothedGraphics

Gets and sets the shape of graph symbols to be used as default

public bool UseSmoothedGraphics { get; set; }

Property Value

bool

UseSpecialNumberOfDigitsForColorLegend

If true, a specially defined number of digits will be used for color legend labels.

public bool UseSpecialNumberOfDigitsForColorLegend { get; set; }

Property Value

bool

UseStandardRangeForCAView

Shall the standard range be used as default for the view of harmonic fields?

public bool UseStandardRangeForCAView { get; set; }

Property Value

bool

UseTransparencyForClipboard

Gets and sets whether document windows copied to the clipboard have a transparent background.

public bool UseTransparencyForClipboard { get; set; }

Property Value

bool

UseZOSAPI

Gets and sets whether the ZOSAPI_NetHelper.dll (and thus Zemax OpticStudio®) is used for the import of Zemax files.

public bool UseZOSAPI { get; set; }

Property Value

bool

UserDefinedFieldSizeLimitForAlgorithms

Gets and sets whether the user defined its own

public bool UserDefinedFieldSizeLimitForAlgorithms { get; set; }

Property Value

bool

WarnBeforeExceedingLimits

Gets and sets whether a warning dialog shall be opened if an array will be created which exceeds the specified limits in number of sampling, number of member fields, or RAM consumption.

public bool WarnBeforeExceedingLimits { get; set; }

Property Value

bool

Wavelength

Gets and sets the default wavelength in meters.

public double Wavelength { get; set; }

Property Value

double

YAxisColor_left_MultiGraphMode

Gets and sets the color of the left y-axis and its associated graphs in multigraph mode to be used as default.

public Color YAxisColor_left_MultiGraphMode { get; set; }

Property Value

Color

YAxisColor_right_MultiGraphMode

Gets and sets the color of the right y-axis and its associated graphs in multigraph mode to be used as default.

public Color YAxisColor_right_MultiGraphMode { get; set; }

Property Value

Color

Methods

Clone()

Clones the current object.

public override object Clone()

Returns

object

Deep copy of this object.

Equals(object?, EqualityIntent)

Determines whether the specified object, is equal to this instance.

public override bool Equals(object? otherObject, EqualityIntent equalityIntent)

Parameters

otherObject object

The object to compare with this instance.

equalityIntent EqualityIntent

The equality intent.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

InitParallelProcessingConfiguration(int?)

public method to trigger the configuration of parallel processing option for complete VirtualLab.

public void InitParallelProcessingConfiguration(int? numberOfMKLThreads = null)

Parameters

numberOfMKLThreads int?

Load()

Loads the file used for storing the global options automatically, i.e. without user interaction. If this file could not be loaded default values are used.

public static GlobalOptions Load()

Returns

GlobalOptions

The loaded global options. A new GlobalOptions object if the file could not be loaded.

Load(string)

Loads the specified file and sets the static VirtualLabAPI.Core.Common.GlobalOptions.FilePath property to it. If this file could not be loaded an exception is thrown.

public static GlobalOptions Load(string filePath)

Parameters

filePath string

Full path of the file.

Returns

GlobalOptions

The loaded global options.

Save()

Saves this object into the User Data directory using a default file name.

public void Save()

Save(string)

Saves this object into a file.

public void Save(string fileName)

Parameters

fileName string

Complete path of file.