Programming Reference for VirtualLab Fusion  2026.1
Loading...
Searching...
No Matches
OrderInfo Class Referenceabstract

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class to store the results of a single order as obtained by rigorous simulations: order number, Rayleigh coefficients, diffraction efficiency. More...

Inheritance diagram for OrderInfo:

Public Member Functions

override bool Equals (object otherObject, EqualityIntent equalityIntent)
 Determines whether the specified Object is equal to this instance.
 
override int GetHashCode ()
 
 OrderInfo (Vector3C rayleighCoefficients, double efficiency, int m, int n=0)
 Initializes a new instance of the OrderInfo class.
 

Properties

double Efficiency [get, set]
 Gets and sets the diffraction efficiency of the order.
 
Vector OrderNumber [get, set]
 Gets and sets the order number (for x- and y-direction).
 
Vector3C RayleighCoefficients [get, set]
 Gets and sets the Rayleigh coefficients (Ex, Ey, and Ez) of the order.
 

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class to store the results of a single order as obtained by rigorous simulations: order number, Rayleigh coefficients, diffraction efficiency.

Constructor & Destructor Documentation

◆ OrderInfo()

OrderInfo ( Vector3C rayleighCoefficients,
double efficiency,
int m,
int n = 0 )

Initializes a new instance of the OrderInfo class.

Parameters
rayleighCoefficientsThe Rayleigh coefficients (Ex, Ey, and Ez) of the order.
efficiencyThe diffraction efficiency of the order.
mThe number of the order in x-direction.
nThe number of the order in y-direction. Can be omitted if the results have been calculated for a system having no modulation in y-direction.

Member Function Documentation

◆ Equals()

override bool Equals ( object otherObject,
EqualityIntent equalityIntent )

Determines whether the specified Object is equal to this instance.

Parameters
otherObjectThe Object to compare with this instance.
equalityIntentDefines what kind of equality you want to check when comparing two objects, for example all values or just physical equality.
Returns
true if the specified Object is equal to this instance; otherwise, false.