VirtualLabAPI.Core.Common Namespace Reference

Classes
class	GlobalOptions
	This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. This class stores all properties which can be set in the Global Options dialog. More...
class	Globals
	This class stores global settings and holds several programming interfaces. More...
interface	IActiveDocumentHistory
	Interface providing access to documents in current VirtualLab session. More...
interface	IDataDisplay
	Interface providing methods to add documents or messages to FormMain. More...
interface	IDocument
	Interface implemented by all VirtualLab documents. More...

Enumerations
enum	DocumentFilter {   All , ResultDocument , CAorHFS , AnyField ,   AnySpatialField , AnySpectralField , Diagram1DOrFieldComponentAtPoint , Diagram2DOrFieldComponent ,   DataArray1D2D , HarmonicFieldsSet , StandardTransmissionDesign , DiagramData ,   Diagram1D , Diagram2D , Module , ComplexAmplitude ,   LightPathDiagram , RayTracingResult2D , NonEquidistantFieldValues , PositionsWavefrontPhaseAndDirection ,   RayTracingResult3D , PlaneWavesField , OpticalSystem , SphericalLensCalculator ,   CoherenceCalculator , ParameterRun , OptimizationDocument , BitmapSequence ,   DataArray , DataArray2D , DataArray1D , SetOfDataArrayGridless2D ,   SetOfDataArray1D , SetOfDataArray2D , DataArrayGridless2D , OrderCollection ,   ChromaticFieldsSet , ChromaticFieldsSet2D , ChromaticFieldsSet1D , LightFieldObject ,   LightFieldObject1D , LightFieldObject2D , FieldComponent , FieldComponentAtLine ,   FieldComponentAtPoint , PulseComponent , PulseComponentAtLine , PulseComponentAtPoint ,   LLGAResultGenerator , Region1D , Region2D , CASignalRegion ,   CATransmission , CAComplexAmplitudeField , CAScalar , CAVectorial ,   CASpectral , CASpatial , HfsSpatial , HfsSpectral ,   CASpectralSignalRegion , CASpatialSignalRegion , CASpatialComplexAmplitudeField , CASpectralComplexAmplitudeField ,   CAVectorialComplexAmplitudeField , CAScalarComplexAmplitudeField , CAVectorialSpectral , CAVectorialSpatial ,   CAScalarSpatial , CAScalarSpectral , CAScalarSpatialComplexAmplitudeField , CAScalarSpectralComplexAmplitudeField }
	Enum containing document types supported by VirtualLab and "OR" combinations of several types. Used by IActiveDocumentHistory. More...

Enumeration Type Documentation

DocumentFilter

enum DocumentFilter

Enum containing document types supported by VirtualLab and "OR" combinations of several types. Used by IActiveDocumentHistory.

Enumerator
All	Any document.
ResultDocument	The usual result of a calculation, i. e. those windows that somehow show a function f(x_1, x_2, ....): harmonic fields, harmonic fields sets, diagrams, bitmap sequences, data arrays and derived types.
CAorHFS	Either a ComplexAmplitude or a HarmonicFieldsSet. Intended for copying view settings.
AnyField	Either a Harmonic Field or a Harmonic Fields Set.
AnySpatialField	Any field in spatial domain.
AnySpectralField	Any field in spectral domain.
Diagram1DOrFieldComponentAtPoint	A one-dimensional diagram or light field object.
Diagram2DOrFieldComponent	A one-dimensional diagram or light field object.
DataArray1D2D	A gridded data array (1D or 2D).
HarmonicFieldsSet	Any Harmonic Field Sets object
StandardTransmissionDesign	Standard Transmission Design.
DiagramData	Diagram Data.
Diagram1D	1D Diagram.
Diagram2D	2D Diagram.
Module	Module.
ComplexAmplitude	Complex Amplitude.
LightPathDiagram	Light Path Diagram
RayTracingResult2D	document filter for the result of the ray tracing engine in VirtualLab (since 5.10)
NonEquidistantFieldValues	document filter for the non-equidistant field values
PositionsWavefrontPhaseAndDirection	document filter for the results to carry positions, wavefront phase and directions
RayTracingResult3D	document filter for the result of the 3D ray tracing system analyzer in VirtualLab (since 5.10)
PlaneWavesField	PlaneWavesField.
OpticalSystem	Spread Sheet.
SphericalLensCalculator	Spherical Lens Calculator
CoherenceCalculator	Coherence Time & Length Calculator
ParameterRun	Parameter run document
OptimizationDocument	Optimization document
BitmapSequence	Bitmap Sequence, i.e. Field Animation
DataArray	Either a one- or two-dimensional data array
DataArray2D	DataArray 2D document
DataArray1D	DataArray 1D document
SetOfDataArrayGridless2D	Set of Gridless DataArray 2D document
SetOfDataArray1D	Set of Gridded DataArray 2D document
SetOfDataArray2D	Set of Gridded DataArray 1D document
DataArrayGridless2D	Gridless DataArray 2D document
OrderCollection	Order collection
ChromaticFieldsSet	One- or two-dimensional chromatic fields set.
ChromaticFieldsSet2D	Chromatic Fields Set
ChromaticFieldsSet1D	Chromatic Fields Set 1D
LightFieldObject	Light Field Objects like e.g. FieldComponent, FieldComponentAtLine, PulseComponent, PulseComponentAtPoint
LightFieldObject1D	Light Field Objects like e.g. FieldComponentAtPoint, PulseComponentAtPoint
LightFieldObject2D	Light Field Objects like e.g. FieldComponent, FieldComponentAtLine, PulseComponent, PulseComponentAtLine
LLGAResultGenerator	LLGA Result generator
Region1D	A one-dimensional region.
Region2D	The two-dimensional region.
CASignalRegion	Any Signal Region.
CATransmission	Any Transmission.
CAComplexAmplitudeField	Any Complex Amplitude Field
CAScalar	Any globally polarized Complex Amplitude.
CAVectorial	Any locally polarized Complex Amplitude.
CASpectral	Any spectral Complex Amplitude.
CASpatial	Any spatial Complex Amplitude.
HfsSpatial	Any spatial Harmonic Fields Set.
HfsSpectral	Any spectral Harmonic Fields Set.
CASpectralSignalRegion	Complex Amplitude containing spectral Signal Region.
CASpatialSignalRegion	Complex Amplitude containing spatial Signal Region.
CASpatialComplexAmplitudeField	(Globally or locally polarized) spatial Complex Amplitude Field
CASpectralComplexAmplitudeField	(Globally or locally polarized) spectral Complex Amplitude Field
CAVectorialComplexAmplitudeField	Locally polarized Harmonic Field.
CAScalarComplexAmplitudeField	Globally polarized Complex Amplitude Field in spatial or spectral domain
CAVectorialSpectral	Any locally polarized spectral Complex Amplitude.
CAVectorialSpatial	Any locally polarized spatial Complex Amplitude.
CAScalarSpatial	Any globally polarized spatial Complex Amplitude.
CAScalarSpectral	Any globally polarized spectral Complex Amplitude.
CAScalarSpatialComplexAmplitudeField	Globally polarized Complex Amplitude containing Harmonic Field in spatial domain.
CAScalarSpectralComplexAmplitudeField	Globally polarized Complex Amplitude containing Harmonic Field in spectral domain.