makVrv::DtDouglasSwellState Class Reference

The DtDouglasSwellState is a utility class for converting sea-swell lengths and heights to/from the Douglas Sea Scale as described by Wikipedia. More...

Classes
class	Swell
	A class describing the profile of a sea-swell. More...

Public Types
enum	Scale {   NoSwell = 0, VeryLow, Low, Light,   Moderate, ModerateRough, Rough, High,   VeryHigh, Confused, MaxDouglasSwellScale }

Public Member Functions
	DtDouglasSwellState (unsigned int index=0, DtUnicode name=DtUnicode(), const Swell &value=Swell(), const Swell &minimum=Swell(), const Swell &maximum=Swell())

Static Public Member Functions
Conversion functions:
static DtUnicode	convertIndexToName (unsigned int index)
static unsigned int	convertNameToIndex (DtUnicode name)
static Swell	convertIndexToSwell (unsigned int index)
static unsigned int	convertSwellToIndex (const Swell &swell)

Private Types
typedef std::vector < DtDouglasSwellState >	SwellStateList

Private Attributes
unsigned int	myIndex
DtUnicode	myName
Swell	myValue
Swell	myMinimum
Swell	myMaximum

Static Private Attributes
static SwellStateList	myStates

Detailed Description

The DtDouglasSwellState is a utility class for converting sea-swell lengths and heights to/from the Douglas Sea Scale as described by Wikipedia.

Member Typedef Documentation

typedef std::vector<DtDouglasSwellState> makVrv::DtDouglasSwellState::SwellStateList

private

Member Enumeration Documentation

enum makVrv::DtDouglasSwellState::Scale

Enumerator
NoSwell
VeryLow
Low
Light
Moderate
ModerateRough
Rough
High
VeryHigh
Confused
MaxDouglasSwellScale

Constructor & Destructor Documentation

makVrv::DtDouglasSwellState::DtDouglasSwellState	(	unsigned int	index = 0,
		DtUnicode	name = DtUnicode(),
		const Swell &	value = Swell(),
		const Swell &	minimum = Swell(),
		const Swell &	maximum = Swell()
	)

Member Function Documentation

static DtUnicode makVrv::DtDouglasSwellState::convertIndexToName ( unsigned int  index )

static

Conversion between swell-state index and name.

static unsigned int makVrv::DtDouglasSwellState::convertNameToIndex ( DtUnicode  name )

static

static Swell makVrv::DtDouglasSwellState::convertIndexToSwell ( unsigned int  index )

static

Conversion between swell-state index and swell.

Note

All swell lengths and heights are measured in meters.

static unsigned int makVrv::DtDouglasSwellState::convertSwellToIndex ( const Swell &  swell )

static

Member Data Documentation

unsigned int makVrv::DtDouglasSwellState::myIndex

private

DtUnicode makVrv::DtDouglasSwellState::myName

private

Swell makVrv::DtDouglasSwellState::myValue

private

Swell makVrv::DtDouglasSwellState::myMinimum

private

Swell makVrv::DtDouglasSwellState::myMaximum

private

SwellStateList makVrv::DtDouglasSwellState::myStates

staticprivate

---

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

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