ocean_model Class Reference
[Ocean Model]

Collaboration diagram for ocean_model:
Collaboration graph
[legend]

Detailed Description

Combines the effects of surface, bottom, volume, and profile into a single model.


Constructor & Destructor Documentation

ocean_model ( boundary_model surface,
boundary_model bottom,
profile_model profile,
std::vector< volume_model * > *  volume = NULL 
) [inline]

Associate ocean parts with this model.

The ocean model takes over ownership of these models and destroys them in its destructor.

virtual ~ocean_model (  )  [inline, virtual]

Destroys ocean model components.


Member Function Documentation

void add_volume ( volume_model layer  )  [inline]

Adds a layer to list of ocean volumes.

boundary_model& bottom (  )  [inline]

Retrieve current model for the ocean bottom.

size_t num_volume (  )  [inline]

Retrieve number of ocean volume layers.

profile_model& profile (  )  [inline]

Retrieve current model for the ocean profile.

boundary_model& surface (  )  [inline]

Retrieve current model for the ocean surface.

volume_model& volume ( std::vector< volume_model * >::size_type  n  )  [inline]

Retrieve one layer of the ocean volume.


Member Data Documentation

boundary_model* _bottom [private]

Model of the ocean bottom.

profile_model* _profile [private]

Model of the sound speed profile and attenuation.

Model of the ocean surface.

std::vector<volume_model*> _volume [private]

Models of ocean volume scattering strength layers.


Generated on 4 May 2015 for USML by  doxygen 1.6.1