class QucEquipmentModel : public CorPersistent

a model of an instrument equipment

Inheritance:


Public Fields

static const char* KeyName
$Id: QucEquipmentModel

Public Methods

QucDirection getDirection ()
RWCString getName ()
const DfcParameter* getParameter ( const RWCString& aName )
const DfcSignature& getSig ()
RWCString getType ()
void getWaveBand ( double& aLowerLimit, double& anUpperLimit )
virtual void getWaveBand ( QucUnitType aUnit, double& aLowerLimit, double& anUpperLimit )
virtual CorPersistent* makeClone ()
QucEquipmentModel& operator= ( const QucEquipmentModel& aRef )
QucEquipmentModel ( const RWCString& aName, QucTransform aTransform = QucEM_GEOM_TRANSFORM )
virtual CorBool readIDF ( DfcIdf& anIDF )
void setDirection ( const QucDirection& aDir )
void setName ( const RWCString& aName )
void setParameter ( const RWCString& aName, const DfcValue& aValue )
void setTransform ( QucTransform aType )
void setType ( const RWCString& aType )
void setWaveBand ( double aLowerBound, double anUpperBound )
virtual void stream ( CorStream& aStream )
virtual QucObservationModel transform ( const QucObservationModel& anObservation, const RWCString& aMode = "all" )
virtual void writeIDF ( DfcIdf& anIDF )
virtual ~QucEquipmentModel ()

Public


Purpose
Query the name of this equipment

Purpose
Set the direction of this equipment

Purpose
Query the name of this equipment

Purpose
The d'tor

Protected Methods

DfcSignature& getSig ()
virtual QucObservationModel leafTransform ( const QucObservationModel& anObservation, const RWCString& aMode = "all" )
QucEquipmentModel ( const QucEquipmentModel& aRef )

Protected


Purpose
Query the signature of this equipment

Purpose
Make a clone of this instance

Private Methods

friend void utest_QucEquipmentModel (CorUnitTest&)
Purpose
Query the signature of this equipment

Documentation

a model of an instrument equipment
static const char* KeyName
$Id: QucEquipmentModel.h,v 1.9 1997/04/11 14:10:54 mwiedmer Exp $

SYNOPSIS

    #include <QucEquipmentModel.h>
  
    QucEquipmentModel myObject;
  

DESCRIPTION
This is the base class of all instruments.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
CorBase

QucEquipmentModel& operator=( const QucEquipmentModel& aRef )

virtual ~QucEquipmentModel()

Purpose
The d'tor.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

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

RWCString getName()

Purpose
Query the name of this equipment.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the name of this instance.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void setName( const RWCString& aName )

RWCString getType()

Purpose
Query the name of this equipment.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the type of this instance.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void setType( const RWCString& aType )

void setWaveBand( double aLowerBound, double anUpperBound )

void getWaveBand( double& aLowerLimit, double& anUpperLimit )

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

void setTransform( QucTransform aType )

void setDirection( const QucDirection& aDir )

QucDirection getDirection()

Purpose
Set the direction of this equipment.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

const DfcParameter* getParameter( const RWCString& aName )

void setParameter( const RWCString& aName, const DfcValue& aValue )

virtual void stream( CorStream& aStream )

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.

QucEquipmentModel( const RWCString& aName, QucTransform aTransform = QucEM_GEOM_TRANSFORM )

QucEquipmentModel( const QucEquipmentModel& aRef )

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

DfcSignature& getSig()

Purpose
Query the signature of this equipment.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the signature of this equipment model.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

const DfcSignature& getSig()

friend void utest_QucEquipmentModel(CorUnitTest&)
Purpose
Query the signature of this equipment.

Preconditions

Returns
This function returns the signature of this equipment model.

Exceptions


Direct child classes:
QucPSF
QucLens
QucGrism
QucGrating
QucFilter
QucDetector
QucCompositeModel
QucAtmosphere

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