class QucLens : public QucEquipmentModel

a model of a lens

Inheritance:

Public Fields

static const char* KeyFocalX
$Id: QucLens

Public Methods

double getDiameter ()
double getFocalX ()
double getFocalY ()
double getObstruction ()
QucProjectionMode getProjectionMode ()
QucProjectionMode getProjMode ()
double getSurface ()
RWCString getUnit ()
virtual void getWaveBand ( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit )
virtual QucObservationModel leafTransform ( const QucObservationModel& anObservation, const RWCString& aMode = "all" )
virtual CorPersistent* makeClone ()
QucLens& operator= ( const QucLens& aRef )
QucLens ( double aFocalX = 0, double aFocalY = 0, double aDiameter = 0, double aObstruction = 0, const RWCString& aUnit = "m", QucProjectionMode aProjectionMode = QucPM_TO_POSITION )
QucLens ( const QucLens& aRef )
virtual CorBool readIDF ( DfcIdf& anIDF )
void recalc ()
void setProjectionMode ( QucProjectionMode aProjMode )
virtual void writeIDF ( DfcIdf& anIDF )
virtual ~QucLens ()

Public


Purpose
Query the surface of this instance

Purpose
Query the projection mode of this instance

Purpose
Query the projection mode of this instance

Purpose
Query the diamater of this instance

Purpose
Query the obstruction of this instance

Purpose
The d'tor

Purpose
Query the X focal of this instance

Purpose
Query the Y focal of this instance

Purpose
Query the unit of this instance

Private Methods

friend void utest_QucLens (CorUnitTest&)
Purpose
Initialise this instance

Private


Purpose
Make a clone of this instance

Documentation

a model of a lens
static const char* KeyFocalX
$Id: QucLens.h,v 2.3 1997/07/11 08:48:40 mwiedmer Exp $

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, const RWCString& aUnit = "m", QucProjectionMode aProjectionMode = QucPM_TO_POSITION )

QucLens( const QucLens& aRef )

QucLens& operator=( const QucLens& aRef )

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, const RWCString& aMode = "all" )

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

QucProjectionMode getProjectionMode()

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 )

double getDiameter()

Purpose
Query the diamater of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the diameter.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

double getObstruction()

Purpose
Query the obstruction of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the obstruction.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

double getSurface()

Purpose
Query the surface of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the surface in cm^2.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

double getFocalX()

Purpose
Query the X focal of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the X focal.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

double getFocalY()

Purpose
Query the Y focal of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the Y focal.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

RWCString getUnit()

Purpose
Query the unit of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a string representation of the unit.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucProjectionMode getProjMode()

Purpose
Query the projection mode of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the projection mode.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

virtual CorBool readIDF( DfcIdf& anIDF )

virtual void writeIDF( DfcIdf& anIDF )

virtual CorPersistent* makeClone()

Purpose
Make a clone of this instance.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function retutns a pointer to a newly created instance that has the same properties as this one.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void recalc()

friend void utest_QucLens(CorUnitTest&)
Purpose
Initialise this instance.
Values that depend on other publically available values will be set in this method.

Preconditions

Exceptions

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de