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.

Classes
class	Swell

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

Public Member Functions
	DtDouglasSwellState (DtDouglasSwellState::Scale enumIndex=Scale::NoSwell, DtUnicode name=DtUnicode(), const Swell &value=Swell(), const Swell &minimum=Swell(), const Swell &maximum=Swell())

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

Private Types
typedef std::vector < DtDouglasSwellState >	SwellStateList

Private Attributes
DtDouglasSwellState::Scale	myIndex
DtUnicode	myName
Swell	myValue
Swell	myMinimum
Swell	myMaximum

Static Private Attributes
static SwellStateList	myStates

Member Typedef Documentation

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

private

Member Enumeration Documentation

enum makVrv::DtDouglasSwellState::Scale

strong

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

Constructor & Destructor Documentation

makVrv::DtDouglasSwellState::DtDouglasSwellState	(	DtDouglasSwellState::Scale	enumIndex = Scale::NoSwell,
		DtUnicode	name = DtUnicode(),
		const Swell &	value = Swell(),
		const Swell &	minimum = Swell(),
		const Swell &	maximum = Swell()
	)

Member Function Documentation

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

static

Conversion between swell-state index and name.

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

static

Conversion between swell-state index and name.

static Swell makVrv::DtDouglasSwellState::convertIndexToSwell ( DtDouglasSwellState::Scale  index )

static

Conversion between swell-state index and swell.

Note

All swell lengths and heights are measured in meters.

static DtDouglasSwellState::Scale makVrv::DtDouglasSwellState::convertSwellToIndex ( const Swell &  swell )

static

Conversion between swell-state index and swell.

Note

All swell lengths and heights are measured in meters.

Member Data Documentation

DtDouglasSwellState::Scale 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.vrf5-1-branch/include/vrvUtil/DtDouglasSeaScale.h