WXP::VCoord Class Reference

This structure defines a vertical coordinate (type,val) More...

#include "../include/VCoord.h"

Public Types
enum	Type {   SFC , FREEZE , LCL , MAXWND ,   TROP , PRES , HEIGHT , POT }

Public Member Functions
	VCoord ()
	VCoord (int rtype, float rval)
int	init ()
int	set (int rtype, float rval)
int	setType (int rtype)
int	getType ()
int	setVal (float rval)
float	getVal ()
int	print ()

Static Public Member Functions
static bool	equal (VCoord a, VCoord b)

Static Public Attributes
static const int	PRESS = PRES

Friends
class	Level

Detailed Description

This structure defines a vertical coordinate (type,val)

Author

Dan Vietor

Member Enumeration Documentation

Type

enum WXP::VCoord::Type

Vertical coordinate types

Enumerator
SFC	Surface level
FREEZE	Freezing level
LCL	LCL level
MAXWND	Max wind level
TROP	Tropopause level
PRES	Pressure level
HEIGHT	Height level
POT	Potential temperature level

Constructor & Destructor Documentation

VCoord() [1/2]

VCoord::VCoord

(

)

Constructor. Initializes class values

References init().

VCoord() [2/2]

VCoord::VCoord	(	int	rtype,
		float	rval
	)

Constructor. Sets the values

Parameters

ru	U value
rv	V value

References set().

Member Function Documentation

equal()

bool VCoord::equal ( VCoord  a, VCoord  b  )

static

Tests for the equality of two VCoords

Parameters

a	The first level
b	The second level

Returns

True if equal

Referenced by WXP::UpaCalc::meanValue().

getType()

int WXP::VCoord::getType ( )

inline

Gets the type of vertical coordinate

Referenced by WXP::UpaCalc::thickBottom(), and WXP::UpaCalc::thickTop().

getVal()

float WXP::VCoord::getVal ( )

inline

Gets the value of the vertical coordinate

Referenced by WXP::UpaCalc::meanValue(), WXP::UpaCalc::thickBottom(), and WXP::UpaCalc::thickTop().

init()

int VCoord::init

(

)

Initializes the class

References WXP::Const::MISS, and PRES.

Referenced by WXP::Level::getLower(), WXP::Level::getUpper(), WXP::UpaCalc::thickBottom(), WXP::UpaCalc::thickTop(), and VCoord().

print()

int VCoord::print

(

)

Prints the object values

References FREEZE, HEIGHT, LCL, MAXWND, POT, PRES, SFC, and TROP.

set()

int VCoord::set	(	int	rtype,
		float	rval
	)

Sets the values

Parameters

ru	U value
rv	V value

Referenced by WXP::UpaDataTool::compute(), WXP::ProfPlot::draw(), WXP::UpaXSectCont::draw(), WXP::UpaXSectPlot::draw(), WXP::ParcelParams::set(), and VCoord().

setType()

int WXP::VCoord::setType ( int  rtype )

inline

Sets the type of vertical coordinate

Referenced by WXP::UpaCalc::thickBottom(), and WXP::UpaCalc::thickTop().

setVal()

int WXP::VCoord::setVal ( float  rval )

inline

Sets the value of the vertical coordinate

Referenced by WXP::UpaCalc::thickBottom(), and WXP::UpaCalc::thickTop().

Member Data Documentation

PRESS

const int WXP::VCoord::PRESS = PRES

static

Same as PRES

Deprecated:

---

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

• VCoord.h
• VCoord.cc