makVrv::DtDouglasSeaState Class Reference

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

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

Public Member Functions
	DtDouglasSeaState (unsigned int index=0, const std::string &name=std::string(""), float minimum=0.0, float maximum=0.0)

Static Public Member Functions
Conversion functions:
static std::string	convertIndexToName (unsigned int index)
static unsigned int	convertNameToIndex (const std::string &name)
static float	convertIndexToWaveHeight (unsigned int index)
static unsigned int	convertWaveHeightToIndex (float height)

Private Types
typedef std::vector < DtDouglasSeaState >	SeaStateList

Private Attributes
unsigned int	myIndex
std::string	myName
float	myMinimum
float	myMaximum

Static Private Attributes
static SeaStateList	myStates

Detailed Description

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

Member Typedef Documentation

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

private

Member Enumeration Documentation

enum makVrv::DtDouglasSeaState::Scale

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

Constructor & Destructor Documentation

makVrv::DtDouglasSeaState::DtDouglasSeaState	(	unsigned int	index = 0,
		const std::string &	name = std::string(""),
		float	minimum = 0.0,
		float	maximum = 0.0
	)

Member Function Documentation

static std::string makVrv::DtDouglasSeaState::convertIndexToName ( unsigned int  index )

static

Conversion between sea-state index and name.

static unsigned int makVrv::DtDouglasSeaState::convertNameToIndex ( const std::string &  name )

static

static float makVrv::DtDouglasSeaState::convertIndexToWaveHeight ( unsigned int  index )

static

Conversion between sea-state index and wave heights.

Note

All wave heights are measured in meters.

static unsigned int makVrv::DtDouglasSeaState::convertWaveHeightToIndex ( float  height )

static

Member Data Documentation

unsigned int makVrv::DtDouglasSeaState::myIndex

private

std::string 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.vrf4-8-branch/include/vrvUtil/DtDouglasSeaScale.h