class QucPlane : public CorBase

a model of a plane (not the flying one)

Inheritance:

public members:

	QucPlane ()
	QucPlane ( QucDirection aDirection ) QucDirection aDirection
	QucPlane ( const QucPlane & aRef ) const QucPlane & aRef
QucPlane &	operator= ( const QucPlane & aRef ) const QucPlane & aRef
virtual	~QucPlane ()
QucDirection	refract ( QucDirection aDirection, double aNin, double aNout ) QucDirection aDirection double aNin double aNout
virtual QucObservationModel	transform ( const QucObservationModel & anObservation, CorString aMode = "all" ) const QucObservationModel & anObservation CorString aMode
double	index ( double aLambda ) double aLambda
void	print ()

SYNOPSIS

    #include <QucPlane.h>
  
    QucPlane myObject;
  

DESCRIPTION
This class models a plane with respect to its refraction.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
QucDirection

QucPlane ()

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucPlane ( QucDirection aDirection )

Purpose
Construct a plane with a certain refraction direction.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection aDirection

the direction

QucPlane ( const QucPlane & 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 QucPlane & aRef

the reference instance

QucPlane & operator= ( const QucPlane & 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 QucPlane & aRef

the reference instance

virtual ~QucPlane ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucDirection refract ( QucDirection aDirection, double aNin, double aNout )

Purpose
Calculate the refraction of the plane.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the refraction of the plane.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection aDirection

some direction

double aNin

some in number

double aNout

some out number

virtual QucObservationModel transform ( 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

double index ( double aLambda )

Purpose
Query the index.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aLambda

some wavelength

void print ()

Purpose
Print out this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

generated by doc++