makVrv::DtDouglasSeaState Class Reference

The DtDouglasSeaState is a utility class for converting wave heights to/from the Douglas Sea Scale as described by Wikipedia.

Public Types
enum	Scale {   Scale::CalmGlassy = 0, Scale::CalmRippled, Scale::Smooth, Scale::Slight,   Scale::Moderate, Scale::Rough, Scale::VeryRough, Scale::High,   Scale::VeryHigh, Scale::Phenomenal, Scale::MaxDouglasSeaScale }

Public Member Functions
	DtDouglasSeaState (DtDouglasSeaState::Scale enumIndex=Scale::CalmGlassy, DtUnicode name=DtUnicode(), float minimum=0.0, float maximum=0.0)

Static Public Member Functions
Conversion functions:
static DtUnicode	convertIndexToName (DtDouglasSeaState::Scale index)
static DtDouglasSeaState::Scale	convertNameToIndex (DtUnicode name)
static float	convertIndexToWaveHeight (DtDouglasSeaState::Scale index)
static DtDouglasSeaState::Scale	convertWaveHeightToIndex (float height)

Private Types
typedef std::vector < DtDouglasSeaState >	SeaStateList

Private Attributes
DtDouglasSeaState::Scale	myIndex
DtUnicode	myName
float	myMinimum
float	myMaximum

Static Private Attributes
static SeaStateList	myStates

Member Typedef Documentation

typedef std::vector<DtDouglasSeaState> makVrv::DtDouglasSeaState::SeaStateList

private

Member Enumeration Documentation

enum makVrv::DtDouglasSeaState::Scale

strong

Enumerator
CalmGlassy
CalmRippled
Smooth
Slight
Moderate
Rough
VeryRough
High
VeryHigh
Phenomenal
MaxDouglasSeaScale

Constructor & Destructor Documentation

makVrv::DtDouglasSeaState::DtDouglasSeaState	(	DtDouglasSeaState::Scale	enumIndex = Scale::CalmGlassy,
		DtUnicode	name = DtUnicode(),
		float	minimum = 0.0,
		float	maximum = 0.0
	)

Member Function Documentation

static DtUnicode makVrv::DtDouglasSeaState::convertIndexToName ( DtDouglasSeaState::Scale  index )

static

Conversion between sea-state index and name.

static DtDouglasSeaState::Scale makVrv::DtDouglasSeaState::convertNameToIndex ( DtUnicode  name )

static

Conversion between sea-state index and name.

static float makVrv::DtDouglasSeaState::convertIndexToWaveHeight ( DtDouglasSeaState::Scale  index )

static

Conversion between sea-state index and wave heights.

Note

All wave heights are measured in meters.

static DtDouglasSeaState::Scale makVrv::DtDouglasSeaState::convertWaveHeightToIndex ( float  height )

static

Conversion between sea-state index and wave heights.

Note

All wave heights are measured in meters.

Member Data Documentation

DtDouglasSeaState::Scale makVrv::DtDouglasSeaState::myIndex

private

DtUnicode makVrv::DtDouglasSeaState::myName

private

float makVrv::DtDouglasSeaState::myMinimum

private

float makVrv::DtDouglasSeaState::myMaximum

private

SeaStateList makVrv::DtDouglasSeaState::myStates

staticprivate

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvUtil/DtDouglasSeaScale.h