BhRun Class Reference

keeps track of all info obtained from one Bellhop run by UanChannelBhp More...

#include <uan-prop-bhp.h>

List of all members.

Public Member Functions

 BhRun ()
 Creates class without information.
 BhRun (double src, double f, set< double > d, set< double > r, char *path)
 Creates class, sets transmitter info, and runs Bellhop.
 BhRun (const BhRun &other)
 Copies the information from this BhRun to another. Allocates new memory for other.
ArrResults & getRes (int d, int r)
 Returns a reference to the ArrResults structure for a receiver at depth d and range r.
const set< double > & getDepths ()
 Returns the set of depths for which this class holds the information for.
const set< double > & getRanges ()
 Returns the set of ranges for which this class has information for.
double getSD ()
 Returns the depth of the transmitter in m.
double getF ()
 Returns the frequency in Hz.


Detailed Description

keeps track of all info obtained from one Bellhop run by UanChannelBhp

This class keeps a set of ArrResults structs for each receiver in a Bellhop simulation (UanChannelBhp runs simulations for each transmitter)

Author:
Leonard Tracy
Date:
9-28-2007
Contact: lentracy@u.washington.edu Created on: June 2007


Constructor & Destructor Documentation

BhRun::BhRun ( double  src,
double  f,
set< double >  d,
set< double >  r,
char *  path 
) [inline]

Creates class, sets transmitter info, and runs Bellhop.

Parameters:
src Source depth in m
f Transmission frequency in Hz
d STL set of all receiver depths
r STL set of all ranges
path C string to Bellhop executable
Runs Bellhop for all information and keeps the results in res


Member Function Documentation

ArrResults& BhRun::getRes ( int  d,
int  r 
) [inline]

Returns a reference to the ArrResults structure for a receiver at depth d and range r.

Parameters:
d Index of depth (shallowest depth is d=0 next shallowest is d=1)
r Index of range (Shortest range is r=0 next shortest is r=1)
I'm not 100% sure if shallowest depth=0/shortest range=0 is correct. It might be opposite (deepest depth=0/longest range=0).


The documentation for this class was generated from the following files:
Generated on Mon Oct 1 12:12:45 2007 for UANModule by  doxygen 1.5.1