class QucMedium : public CorBase

a model of a medium, like water, air, plastic, etc.

Inheritance:

public members:

	QucMedium ( CorString aName = "Generic Medium" ) CorString aName
	QucMedium ( const QucMedium & aRef ) const QucMedium & aRef
QucMedium &	operator= ( const QucMedium & aRef ) const QucMedium & aRef
virtual	~QucMedium ()
void	fitIndex ( int aNumber, double* aLamda, double* anIndex ) int aNumber double* aLamda double* anIndex
double	getIndex ( double aLamda ) const double aLamda
void	setIndex ( double anIndex ) double anIndex
void	print () const

QucMedium ( CorString aName = "Generic Medium" )

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

the reference instance

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

the reference instance

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

the reference instance

virtual ~QucMedium ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void fitIndex ( int aNumber, double* aLamda, double* anIndex )

Purpose

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

int aNumber

number of elements

double* aLamda

wavelength in nm

double* anIndex

index

double getIndex ( double aLamda ) const

Purpose
Query the refraction index for a given wavelength.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the refraction index.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aLamda

wavelength in nm

void setIndex ( double anIndex )

Purpose
Set the refraction index for this medium.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIndex

My new value

void print () const

Purpose
Print out the refraction index.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

generated by doc++