class QucCompositeModel : public QucEquipmentModel

a model of several telescope instruments

Inheritance:

public members:

	QucCompositeModel ()
	QucCompositeModel ( CorString aName ) CorString aName
virtual	~QucCompositeModel ()
virtual QucObservationModel	transform ( 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
void	add ( QucEquipmentModel * aModel ) QucEquipmentModel * aModel
void	remove ( QucEquipmentModel * aModel ) QucEquipmentModel * aModel
virtual CorBool	loadIDF (CorStream& aStream)
virtual CorBool	saveIDF (CorStream& aStream) const

protected members:

	QucCompositeModel ( const QucCompositeModel & aRef ) const QucCompositeModel & aRef
QucCompositeModel &	operator= ( const QucCompositeModel & aRef ) const QucCompositeModel & aRef

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

DESCRIPTION
This class is a composition of several telescope instruments. It may be viewed as a telescope for instance.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
QucEquipmentModel

QucCompositeModel ()

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucCompositeModel ( CorString aName )

Purpose
The 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 this instance

virtual ~QucCompositeModel ()

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 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

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

unit

double& aLowerLimit

lowest wave length

double& anUpperLimit

highest wave length

void add ( QucEquipmentModel * aModel )

Purpose
Add a new equipment to this composition.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucEquipmentModel * aModel

model to add (this instance will take over responsibility)

void remove ( QucEquipmentModel * aModel )

Purpose
Remove an equipment from this composition.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucEquipmentModel * aModel

model to remove

virtual CorBool loadIDF (CorStream& aStream)

Purpose
Read in the parameters of this composite model and all its components.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if it could successfully read the parameters from the database.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

virtual CorBool saveIDF (CorStream& aStream) const

Purpose
Write the parameters of this composite model and all its components.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

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

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

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

the reference instance

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

the reference instance

this class has no child classes.

generated by doc++