class QucGrating : public QucEquipmentModel

a model of a grating

Inheritance:

public members:

	QucGrating ( double aGroove, CorString aType, QucDirection aDirection ) double aGroove CorString aType QucDirection aDirection
	QucGrating ( const QucGrating & aRef ) const QucGrating & aRef
QucGrating &	operator= ( const QucGrating & aRef ) const QucGrating & aRef
virtual	~QucGrating ()
virtual QucObservationModel	leafTransform ( const QucObservationModel & anObservation, CorString aMode = "all" ) const QucObservationModel & anObservation CorString aMode
virtual void	getWaveBand ( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit ) const QucUnitType aUnit double& aLowerLimit double& anUpperLimit
QucDirection	disperse ( QucDirection aDirection, double aLambda, int anOrder, double anInputIndex = 1.0, double anOutputIndex = 1.0 ) const QucDirection aDirection double aLambda int anOrder double anInputIndex double anOutputIndex
int	getOrder ( QucDirection anAlpha, QucDirection aBeta, double aLambda, double anInputIndex = 1.0, double anOutputIndex = 1.0 ) const QucDirection anAlpha QucDirection aBeta double aLambda double anInputIndex double anOutputIndex
double	getWavelength ( QucDirection anAlpha, QucDirection aBeta, int anM, double& aLambdaMin, double& aLambdaMax, double anInputIndex = 1, double anOutputIndex = 1 ) const QucDirection anAlpha QucDirection aBeta int anM double& aLambdaMin double& aLambdaMax double anInputIndex double anOutputIndex
void	setOrder ( int aNumber ) int aNumber
void	setGroove ( double aNumber ) double aNumber
void	print ()

Inherited from QucEquipmentModel:

public members:

QucEquipmentModel & operator=( const QucEquipmentModel & aRef )

const QucEquipmentModel &

aRef

virtual QucObservationModel transform( const QucObservationModel & anObservation, CorString aMode = "all" )

const QucObservationModel &	anObservation
CorString	aMode

CorString getName() const

void setName( CorString aName )

CorString

aName

CorString getType() const

void setType( CorString aType )

CorString

aType

void setWaveBand( double aLowerBound, double anUpperBound )

double	aLowerBound
double	anUpperBound

void getWaveBand( double& aLowerLimit, double& anUpperLimit ) const

double&	aLowerLimit
double&	anUpperLimit

virtual void getWaveBand( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit ) const

QucUnitType	aUnit
double&	aLowerLimit
double&	anUpperLimit

void setTransform( QucTransform aType )

QucTransform

aType

void setDirection( const QucDirection & aDir )

const QucDirection &

aDir

QucDirection getDirection() const

virtual CorStream& operator>>( CorStream& aStream )

CorStream&

aStream

virtual CorStream& operator<<( CorStream& aStream ) const

CorStream&

aStream

CorBool loadIDF( CorStream& aStream )

CorStream&

aStream

CorBool saveIDF( CorStream& aStream ) const

CorStream&

aStream

protected members:

virtual QucObservationModel leafTransform( const QucObservationModel & anObservation, CorString aMode = "all" )

const QucObservationModel &	anObservation
CorString	aMode

DfcSignature& getSig()

const DfcSignature& getSig() const

SYNOPSIS

    #include <QucGrating.h>
  
    QucGrating myObject;
  

DESCRIPTION
This class models a grating.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
QucEquipmentModel

QucGrating ( double aGroove, CorString aType, QucDirection aDirection )

Purpose
The c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aGroove

CorString aType

QucDirection aDirection

QucGrating ( const QucGrating & aRef )

Purpose
The copy c'tor creates a new instance from a reference.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucGrating & aRef

the reference instance

QucGrating & operator= ( const QucGrating & aRef )

Purpose
The assignment operator makes this instance look like another one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
A reference to this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucGrating & aRef

the reference instance

virtual ~QucGrating ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

virtual QucObservationModel leafTransform ( const QucObservationModel & anObservation, CorString aMode = "all" )

Purpose
Transform an observation model according to the rules of the euipment.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a transformed observation model.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & anObservation

observation to transform

CorString aMode

mode

virtual void getWaveBand ( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit ) const

Purpose
Query the waveband of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aUnit

defines in which unit the wavelengths are returned

double& aLowerLimit

lowest wave length

double& anUpperLimit

highest wave length

QucDirection disperse ( QucDirection aDirection, double aLambda, int anOrder, double anInputIndex = 1.0, double anOutputIndex = 1.0 ) const

Purpose
Calculate the dispertion of this grating.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the direction of the dispersion with respect to some input values.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection aDirection

direction

double aLambda

wavelength in nm

int anOrder

double anInputIndex

index on the input side

double anOutputIndex

index on the output side

int getOrder ( QucDirection anAlpha, QucDirection aBeta, double aLambda, double anInputIndex = 1.0, double anOutputIndex = 1.0 ) const

Purpose
Query the order of this grating.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This funciton returns the order of this instance with respect to some input values.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection anAlpha

alpha direction

QucDirection aBeta

beta direction

double aLambda

wavelength in nm

double anInputIndex

index on the input side

double anOutputIndex

index on the output side

double getWavelength ( QucDirection anAlpha, QucDirection aBeta, int anM, double& aLambdaMin, double& aLambdaMax, double anInputIndex = 1, double anOutputIndex = 1 ) const

Purpose
Query a wavelength.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns some wavelength with respect to some data.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection anAlpha

alpha direction

QucDirection aBeta

beta direction

int anM

hu?

double& aLambdaMin

min wavelength in nm

double& aLambdaMax

max wavelength in nm

double anInputIndex

index on the input side

double anOutputIndex

index on the output side

void setOrder ( int aNumber )

Purpose
Set the order number of the grating.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aNumber

order number

void setGroove ( double aNumber )

Purpose
Set the number of grooves of the grating.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aNumber

number of grooves

void print ()

Purpose
Print some attributes.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

generated by doc++