ssInstrumentParameters Class Reference
[Simulator/Common/C++]

A class containing a sepicific set of instrument parameters. More...

#include <ssInstrumentParameters.h>

List of all members.

Public Member Functions

 ssInstrumentParameters ()
 Ctor.
 ssInstrumentParameters (const ssInstrumentParameters &rhs)
 Copy ctor.
 ssInstrumentParameters (int n_beams, double delta_theta)
 Ctor.
virtual ~ssInstrumentParameters ()
 Dtor.
ssInstrumentParametersoperator= (const ssInstrumentParameters &rhs)
 Copy operator.
bool operator== (const ssInstrumentParameters &rhs)
 Equivalence operator.
bool operator!= (const ssInstrumentParameters &rhs)
 Inequivalence operator.
void numberOfBeams (int n)
 Specify the number of beams per swath.
int numberOfBeams () const
 Give the number of beams per swath.
void deltaTheta (double arg)
 Specify the angular spacing between beams.
double deltaTheta () const
 Give the angular spacing between beams.
void halfPowerBeamWidth (double arg)
 Specify the 3dB beam width od each beam.
double halfPowerBeamWidth () const
 Give the 3dB beam width of each beam.


Detailed Description

A class containing a sepicific set of instrument parameters.

Definition at line 13 of file ssInstrumentParameters.h.


Constructor & Destructor Documentation

ssInstrumentParameters::ssInstrumentParameters (  ) 

Ctor.

ssInstrumentParameters::ssInstrumentParameters ( const ssInstrumentParameters rhs  ) 

Copy ctor.

Parameters:
rhs The reference object.

ssInstrumentParameters::ssInstrumentParameters ( int  n_beams,
double  delta_theta 
)

Ctor.

Parameters:
n_beams The number of beams per swath.
delta_theta The angle spacing between each beam in radians.

virtual ssInstrumentParameters::~ssInstrumentParameters (  )  [virtual]

Dtor.


Member Function Documentation

ssInstrumentParameters& ssInstrumentParameters::operator= ( const ssInstrumentParameters rhs  ) 

Copy operator.

Parameters:
rhs The reference object.

bool ssInstrumentParameters::operator== ( const ssInstrumentParameters rhs  ) 

Equivalence operator.

Parameters:
rhs The reference object.
Returns:
True if this object equals the reference.

bool ssInstrumentParameters::operator!= ( const ssInstrumentParameters rhs  ) 

Inequivalence operator.

Parameters:
rhs The reference object.
Returns:
True if this object is not equal to the reference.

void ssInstrumentParameters::numberOfBeams ( int  n  ) 

Specify the number of beams per swath.

Parameters:
n The number of beams.

int ssInstrumentParameters::numberOfBeams (  )  const

Give the number of beams per swath.

Returns:
The number of beams.

void ssInstrumentParameters::deltaTheta ( double  arg  ) 

Specify the angular spacing between beams.

Parameters:
arg The spacing between deams in radians.

double ssInstrumentParameters::deltaTheta (  )  const

Give the angular spacing between beams.

Returns:
The spacing between beams in radians.

void ssInstrumentParameters::halfPowerBeamWidth ( double  arg  ) 

Specify the 3dB beam width od each beam.

Parameters:
arg The width in radians.

double ssInstrumentParameters::halfPowerBeamWidth (  )  const

Give the 3dB beam width of each beam.

Returns:
Width in radians.


The documentation for this class was generated from the following file: