class QucObservationModel

class QucObservationModel : public CorBase

model of an observation

Inheritance:

public members:

QucObservationModel ( int aNumber = 1, CorString aName = "ObservationModel" )

int	aNumber
CorString	aName

QucObservationModel ( const QucObservationModel & aRef )

const QucObservationModel &

aRef

QucObservationModel &

operator= ( const QucObservationModel & aRef )

const QucObservationModel &

aRef

CorBool

operator== ( const QucObservationModel & aRef )

const QucObservationModel &

aRef

CorBool

operator!= ( const QucObservationModel & aRef )

const QucObservationModel &

aRef

virtual

~QucObservationModel ()

QucOpticalRay

operator[] ( unsigned int aRay ) const

unsigned int

aRay

const QucOpticalRay &

first () const

int

getWaveBand ( double* aLowerLimit, double* aHigherLimit ) const

double*	aLowerLimit
double*	aHigherLimit

int

getSize () const

CorBool

isDone () const

QucObservationModel

photons () const

QucUnitType

getUnitW () const

QucUnitType

getUnitU () const

QucUnitType

getUnitV () const

QucUnitType

getUnitX () const

QucUnitType

getUnitY () const

QucUnitType

getUnitT () const

QucUnitType

getUnitI () const

CorString

getName () const

const QucOpticalRay &

start ()

const QucOpticalRay &

next ()

void

copy ( const QucObservationModel & aRef )

const QucObservationModel &

aRef

void

add ( const QucOpticalRay & aRay )

const QucOpticalRay &

aRay

void

addUV ( double anIntensity = 1, double aU = 0, double aV = 0, double aWaveLength = 550, double aTime = 0 )

double	anIntensity
double	aU
double	aV
double	aWaveLength
double	aTime

void

addXY ( double anIntensity = 1, double anX = 0, double aY = 0, double aWaveLength = 550, double aTime = 0 )

double	anIntensity
double	anX
double	aY
double	aWaveLength
double	aTime

void

clear ()

void writeFile

Documentation

SYNOPSIS

#include <QucObservationModel.h> QucObservationModel myObject;
DESCRIPTION
This class models an observation.
CAUTIONS
<optional>
EXAMPLES
<optional>
SEE ALSO
QucOpticalRay
QucEquipmentModel
CorBase

QucObservationModel ( int aNumber = 1, CorString aName = "ObservationModel" )

Purpose
The default c'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aNumber: number of rays
CorString aName: name of this instance

QucObservationModel ( const QucObservationModel & 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 QucObservationModel & aRef: the reference instance

QucObservationModel & operator= ( const QucObservationModel & 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 QucObservationModel & aRef: the reference instance

CorBool operator== ( const QucObservationModel & aRef )

Purpose
Check if a reference model has the same attributes as this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if the two are equal.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & aRef: the reference instance

CorBool operator!= ( const QucObservationModel & aRef )

Purpose
Check if a reference model has the same attributes as this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if the two are different.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & aRef: the reference instance

virtual ~QucObservationModel ()

Purpose
The d'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucOpticalRay operator[] ( unsigned int aRay ) const

Purpose
Access a specific ray seen by this observation.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a specific ray held by this observation.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

unsigned int aRay: ray

const QucOpticalRay & first () const

Purpose
Return the first ray.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a reference to the first ray.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

int getWaveBand ( double* aLowerLimit, double* aHigherLimit ) const

Purpose
Query the number of rays stored and their highest and lowest wave lengths.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the number of rays held.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double* aLowerLimit: lowest wave length
double* aHigherLimit: highest wave length

int getSize () const

Purpose
Query the number of rays stored.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the number of rays held.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

CorBool isDone () const

Purpose
Has the list been propagated to the end?

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether the last ray has been inspected.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucObservationModel photons () const

Purpose
Convert this observation model from flux to photons.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns an observation model in photon state.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitW () const

Purpose
Query the unit of the wave length.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the wave length.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitU () const

Purpose
Query the unit of the u directional angle.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the u directional angle.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitV () const

Purpose
Query the unit of the v directional angle.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the v directional angle.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitX () const

Purpose
Query the unit of the x tangent.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the x tangent.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitY () const

Purpose
Query the unit of the y tangent.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the y tangent.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitT () const

Purpose
Query the unit of the time.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the time.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucUnitType getUnitI () const

Purpose
Query the unit of the intensity.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the unit of the intensity.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

CorString getName () const

Purpose
Query the name of this observation.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the name of this observation.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

const QucOpticalRay & start ()

Purpose
Query the first optical ray stored and initiate everything for an iteration.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a reference to the first ray held.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

const QucOpticalRay & next ()

Purpose
Query the next ray and continue in the iteration.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the next ray in the iteration.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

void copy ( const QucObservationModel & aRef )

Purpose
Copy the observation model from a reference.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucObservationModel & aRef: reference value

void add ( const QucOpticalRay & aRay )

Purpose
Add a ray to this observation.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucOpticalRay & aRay: ray to add

void addUV ( double anIntensity = 1, double aU = 0, double aV = 0, double aWaveLength = 550, double aTime = 0 )

Purpose
Add a ray to this observation by defining its u and v attributes.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIntensity: ray intensity
double aU: u directional angle, in the units defined for this ObservationModel, (default is degrees)
double aV: V directional angle, in the units defined for this ObservationModel, (default is degrees)
double aWaveLength: wavelength, in the units defined for this ObservationModel, default is nm
double aTime: time, in the units defined for this ObservationModel, default is seconds

void addXY ( double anIntensity = 1, double anX = 0, double aY = 0, double aWaveLength = 550, double aTime = 0 )

Purpose
Add a ray to this observation by defining its x and y attributes.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIntensity: ray intensity
double anX: x tangent
double aY: Y tangent
double aWaveLength: wavelength, in the units defined for this ObservationModel, default is nm
double aTime: time, in the units defined for this ObservationModel, default is seconds

void clear ()

Purpose
Forget about the stored rays, reset any iteration.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

this class has no child classes.

alphabetic index hierarchy of classes

VLT-DFS Subsystem Core - User Manual 1.1

VLT-MAN-ESO-19000-0001

generated by doc++