class QucEquipmentModel : public CorPersistent

a model of an instrument equipment

Inheritance:

public members:

QucEquipmentModel &	operator= ( const QucEquipmentModel & aRef ) const QucEquipmentModel & aRef
virtual	~QucEquipmentModel ()
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:

	QucEquipmentModel ( CorString aName, QucTransform aTransform = QucEM_GEOM_TRANSFORM ) CorString aName QucTransform aTransform
	QucEquipmentModel ( const QucEquipmentModel & aRef ) const QucEquipmentModel & aRef
virtual QucObservationModel	leafTransform ( const QucObservationModel & anObservation, CorString aMode = "all" ) const QucObservationModel & anObservation CorString aMode
DfcSignature&	getSig ()
const DfcSignature&	getSig () const

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

the reference instance

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, CorString aMode = "all" )

Purpose
Transform the supplied observation model, after converting it to the referential of this equipment model.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a transformed observation model, converted back to its original referential.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & anObservation

observation to transform

CorString aMode

mode specifier

CorString getName () const

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 ( CorString aName )

Purpose
Give this equipment a new name.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName

new name

CorString getType () const

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 ( CorString aType )

Purpose
Give this equipment a new type.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aType

new type

void setWaveBand ( double aLowerBound, double anUpperBound )

Purpose
Set the wave band of this equipment.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aLowerBound

new lower bound

double anUpperBound

new upper bound

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

Purpose
Query the wave band of this equipment.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double& aLowerLimit

lowest wave length

double& anUpperLimit

highest wave length

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

Purpose
Query the spectral waveband with respect.

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

void setTransform ( QucTransform aType )

Purpose
Set the transformation type of this equipment.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucTransform aType

new transformation type

void setDirection ( const QucDirection & aDir )

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.

Arguments

const QucDirection & aDir

new direction

QucDirection getDirection () const

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.

virtual CorStream& operator>> ( CorStream& aStream )

Purpose
Read this instance from a stream.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if it could successfully read the instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorStream& aStream

stream to load from

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

Purpose
Write this instance into a stream.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if it could successfully write the instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorStream& aStream

stream to save to

CorBool loadIDF ( CorStream& aStream )

Purpose
Read this instance from a stream.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if it could successfully read the instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorStream& aStream

stream to load from

CorBool saveIDF ( CorStream& aStream ) const

Purpose
Write this instance into a stream.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if it could successfully write the instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorStream& aStream

stream to save to

QucEquipmentModel ( CorString aName, QucTransform aTransform = QucEM_GEOM_TRANSFORM )

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aName

name of the model

QucTransform aTransform

transformation type

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

the reference instance

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

Purpose
Transform this equipment (no referential conversions)...

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 specifier

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 () const

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.

direct child classes: QucLens QucGrism QucGrating QucFilter QucDetector QucCompositeModel QucAtmosphere

generated by doc++