class QucLens : public QucEquipmentModel

a model of a lens

Inheritance:

public members:

	QucLens ( double aFocalX = 0, double aFocalY = 0, double aDiameter = 0, double aObstruction = 0, CorString aUnit = "m", QucProjectionMode aProjectionMode = QucPM_TO_POSITION ) double aFocalX double aFocalY double aDiameter double aObstruction CorString aUnit QucProjectionMode aProjectionMode
	QucLens ( const QucLens & aRef ) const QucLens & aRef
QucLens &	operator= ( const QucLens & aRef ) const QucLens & aRef
virtual	~QucLens ()
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
QucProjectionMode	getProjectionMode () const
void	setProjectionMode ( QucProjectionMode aProjMode ) QucProjectionMode aProjMode

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 <QucLens.h>
  
    QucLens myObject;
  

DESCRIPTION
This is a model of a lens.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
QucEquipmentModel

QucLens ( double aFocalX = 0, double aFocalY = 0, double aDiameter = 0, double aObstruction = 0, CorString aUnit = "m", QucProjectionMode aProjectionMode = QucPM_TO_POSITION )

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aFocalX

x focal

double aFocalY

y focal

double aDiameter

lens diameter

double aObstruction

lens obstruction

CorString aUnit

unit of type length for all of the above values

QucProjectionMode aProjectionMode

Lens transformation mode, taken from ProjectionMode

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

the reference instance

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

the reference instance

virtual ~QucLens ()

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.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the transformed observation.

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

QucProjectionMode getProjectionMode () const

Purpose
Query the projection mode of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void setProjectionMode ( QucProjectionMode aProjMode )

Purpose
Query the projection mode of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucProjectionMode aProjMode

new projection mode to use

generated by doc++