OrderInfo Class Reference

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. More...
	OrderInfo (OrderInfo objectToCopy)
	Copy Constructor. More...
	OrderInfo (Vector3C rayleighCoefficients, double efficiency, int m, int n=0)
	Initializes a new instance of the OrderInfo class. More...

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

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() [1/2]

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

Initializes a new instance of the OrderInfo class.

Parameters

rayleighCoefficients	The Rayleigh coefficients (Ex, Ey, and Ez) of the order.
efficiency	The diffraction efficiency of the order.
m	The number of the order in x-direction.
n	The 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.

OrderInfo() [2/2]

OrderInfo

(

OrderInfo

objectToCopy

)

Copy Constructor.

Parameters

objectToCopy

The object to copy.

Member Function Documentation

Equals()

override bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent
	)

Determines whether the specified Object is equal to this instance.

Parameters

otherObject	The Object to compare with this instance.
equalityIntent	Defines 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.

Property Documentation

Efficiency

double Efficiency

getset

Gets and sets the diffraction efficiency of the order.

OrderNumber

Vector OrderNumber

getset

Gets and sets the order number (for x- and y-direction).

RayleighCoefficients

Vector3C RayleighCoefficients

getset

Gets and sets the Rayleigh coefficients (Ex, Ey, and Ez) of the order.