WXP::Level Class Reference

This class defines vertical level parameters. More...

#include "../include/Level.h"

Public Member Functions
	Level ()
	Level (int t1, float l1, int t2, float l2)
	Level (int t, float l1, float l2)
	Level (int t, int l)
	Level (const char *str)
int	init ()
bool	isSet ()
int	decode (const char *str)
int	toTypeCode ()
int	toLevelCode ()
int	set (int t1, float l1, int t2, float l2)
int	set (int t, float l1, float l2)
int	set (int t, float l)
int	decode (int t, int l)
int	set (const char *str)
int	getType ()
int	getType1 ()
int	getType2 ()
float	getLev1 ()
float	getLev2 ()
int	getLower (VCoord &vc)
int	getUpper (VCoord &vc)
int	toString (String &str)
int	toLabel (String &str)
bool	valid ()
int	print ()
bool	isLayer ()
bool	isPres ()
bool	isHght ()
bool	isPot ()
Static Public Member Functions
static int	toTypeCode (int type1, int type2)
static int	toTypeCode (int type1)
Static Public Attributes
static const int	NONE = -9999
static const int	SND = 0
static const int	SFC = 1
static const int	CLD_BOT = 2
static const int	CLD_TOP = 3
static const int	FRZ = 4
static const int	LCL = 5
static const int	MWND = 6
static const int	TROP = 7
static const int	TOP = 8
static const int	SEABOT = 9
static const int	PR = 100
static const int	MSL = 101
static const int	HT = 102
static const int	HAG = 103
static const int	SIG = 104
static const int	HYB = 105
static const int	HBG = 106
static const int	POT = 107
static const int	PAG = 108
static const int	POT_VORT = 109
static const int	ETA = 111
static const int	MISC = 199
static const int	WHOLE = 200
static const int	TOP_FRZ = 204
static const int	GSCLD_BOT = 206
static const int	GSCLD_TOP = 207
static const int	BLCLD_BOT = 209
static const int	BLCLD_TOP = 210
static const int	BLCLD_LYR = 211
static const int	LCLD_BOT = 212
static const int	LCLD_TOP = 213
static const int	LCLD_LYR = 214
static const int	CLD_CEIL = 215
static const int	PBL = 220
static const int	MCLD_BOT = 222
static const int	MCLD_TOP = 223
static const int	MCLD_LYR = 224
static const int	HCLD_BOT = 232
static const int	HCLD_TOP = 233
static const int	HCLD_LYR = 234
static const int	CONV_BOT = 242
static const int	CONV_TOP = 243
static const int	CONV_LYR = 244
static const int	WBZERO = 245
static const int	MAXEPOT = 246
static const int	EQUILIB = 247
static const int	SCCLD_BOT = 248
static const int	SCCLD_TOP = 249
static const int	DCCLD_BOT = 251
static const int	DCCLD_TOP = 252
static const int	SCLW_BOT = 253
static const int	SCLW_TOP = 254

Detailed Description

This class defines vertical level parameters.

Author:: Dan Vietor

Constructor & Destructor Documentation

Level::Level ( )

Constructor. Initializes data values

References init().

Level::Level	(	int	t1,
		float	l1,
		int	t2,
		float	l2
	)

Constructor. Sets data values for layer

Parameters:

	t1	Type of lower layer
	l1	Lower level
	t2	Type of upper layer
	l2	Upper level

References init().

Level::Level	(	int	t,
		float	l1,
		float	l2
	)

Constructor. Sets data values for layer

Parameters:

	t	Type of layer
	l1	Lower level
	l2	Upper level

References init().

Level::Level	(	int	t,
		int	l
	)

Constructor. Sets data values for level

Parameters:

	t	Type of level
	l	Level value

References init().

Level::Level ( const char * str )

Constructor. Decoded from string

Parameters:

str

String to decode level values

References init().

Member Function Documentation

int Level::decode	(	int	t,
		int	l
	)

Sets the level values from level codes

Parameters:

	t	Type of level
	l	Level value

References ETA, HAG, HBG, HT, HYB, init(), MSL, PAG, POT, POT_VORT, PR, and SIG.

int Level::decode ( const char * str )

Decodes level information from string

Parameters:

str

String to decode

References BLCLD_BOT, BLCLD_LYR, BLCLD_TOP, CLD_CEIL, CONV_BOT, CONV_LYR, CONV_TOP, DCCLD_BOT, DCCLD_TOP, EQUILIB, ETA, FRZ, WXP::Convert::FTtoM(), GSCLD_BOT, GSCLD_TOP, HAG, HCLD_BOT, HCLD_LYR, HCLD_TOP, HT, HYB, WXP::StrLib::iequal(), init(), LCL, LCLD_BOT, LCLD_LYR, LCLD_TOP, MAXEPOT, MCLD_BOT, MCLD_LYR, MCLD_TOP, MISC, MSL, MWND, PAG, PBL, POT, POT_VORT, PR, SCCLD_BOT, SCCLD_TOP, SCLW_BOT, SCLW_TOP, SFC, SIG, SND, TOP_FRZ, TROP, WBZERO, and WHOLE.

Referenced by set().

float WXP::Level::getLev1 ( ) [inline]

Get upper level type

float WXP::Level::getLev2 ( ) [inline]

Get lower level value

int Level::getLower ( VCoord & vc )

Get upper level value

References HT, WXP::VCoord::init(), POT, and PR.

Referenced by WXP::UpaDataTool::compute().

int WXP::Level::getType1 ( ) [inline]

Get level type

int WXP::Level::getType2 ( ) [inline]

Get lower level type

int Level::init ( )

Initializes data values

References WXP::Const::MISS.

Referenced by decode(), WXP::VarSpec::init(), Level(), and set().

bool Level::isHght ( )

Is the level a height level

Returns:: Whether a height level?

References HAG, and HT.

bool Level::isLayer ( )

Is the level a layer

Returns:: Whether a layer?

bool Level::isPot ( )

Is the level a potential temperature level

Returns:: Whether an isentropic level?

References POT.

bool Level::isPres ( )

Is the level a pressure level

Returns:: Whether a pressure level?

References PAG, PR, and SFC.

int Level::print ( )

Prints data values to standard output

References toLevelCode().

Referenced by WXP::VarSpec::printDetails().

int Level::set ( const char * str )

Sets the level values from a string

Parameters:

str

String to decode

References decode().

int Level::set	(	int	t,
		float	l
	)

Sets the level values for a single level

Parameters:

	t	Type of layer
	l	Level

References init().

int Level::set	(	int	t,
		float	l1,
		float	l2
	)

Sets the level values given a layer

Parameters:

	t	Type of layer
	l1	Lower level
	l2	Upper level

References WXP::Const::MISS.

int Level::set	(	int	t1,
		float	l1,
		int	t2,
		float	l2
	)

Sets the level values given a layer

Parameters:

	t1	Type of layer
	l1	Lower level
	t2	Type of layer
	l2	Upper level

References WXP::Const::MISS, PR, and SIG.

Referenced by WXP::UpaRaw::compute(), WXP::UpaPlot::draw(), WXP::GribFile::readPDB(), WXP::GribFile::readPDS(), and WXP::Grid::setLevel().

int Level::toLabel ( String & str )

Outputs a label string from data values

Return values:

str

Output string

References BLCLD_BOT, BLCLD_LYR, BLCLD_TOP, CLD_BOT, CLD_CEIL, CLD_TOP, WXP::String::clear(), CONV_BOT, CONV_LYR, CONV_TOP, DCCLD_BOT, DCCLD_TOP, EQUILIB, FRZ, GSCLD_BOT, GSCLD_TOP, HAG, HBG, HCLD_BOT, HCLD_LYR, HCLD_TOP, HT, HYB, LCL, LCLD_BOT, LCLD_LYR, LCLD_TOP, MAXEPOT, MCLD_BOT, MCLD_LYR, MCLD_TOP, MISC, WXP::Const::MISS, MSL, MWND, PAG, PBL, POT, POT_VORT, PR, WXP::String::printf(), SCCLD_BOT, SCCLD_TOP, SCLW_BOT, SCLW_TOP, SFC, SIG, SND, TOP, TOP_FRZ, TROP, WBZERO, and WHOLE.

Referenced by WXP::GribFile::makeInfo(), and WXP::VarSpec::toInfoLabel().

int Level::toLevelCode ( )

Outputs a level code combining both levels into a single number

Returns:: Level code

References ETA, HAG, HBG, HT, HYB, WXP::Const::MISS, MSL, PAG, POT, POT_VORT, PR, SIG, and WHOLE.

Referenced by print().

int Level::toString ( String & str )

Converts data values to a string

Return values:

str

Output string

References BLCLD_BOT, BLCLD_LYR, BLCLD_TOP, CLD_BOT, CLD_CEIL, CLD_TOP, WXP::String::clear(), CONV_BOT, CONV_LYR, CONV_TOP, DCCLD_BOT, DCCLD_TOP, EQUILIB, FRZ, GSCLD_BOT, GSCLD_TOP, HAG, HBG, HCLD_BOT, HCLD_LYR, HCLD_TOP, HT, HYB, LCL, LCLD_BOT, LCLD_LYR, LCLD_TOP, MAXEPOT, MCLD_BOT, MCLD_LYR, MCLD_TOP, MISC, MSL, MWND, PAG, PBL, POT, POT_VORT, PR, WXP::String::printf(), SCCLD_BOT, SCCLD_TOP, SCLW_BOT, SCLW_TOP, SFC, SIG, SND, TOP, TOP_FRZ, TROP, WBZERO, and WHOLE.

Referenced by WXP::VarSpec::print().

int Level::toTypeCode ( )

Outputs a level type code

Returns:: Level type code

Referenced by WXP::GribFile::readPDB().

Member Data Documentation

const int WXP::Level::BLCLD_BOT = 209 [static]

Boundary layer cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::BLCLD_LYR = 211 [static]

Boundary layer cloud layer

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::BLCLD_TOP = 210 [static]

Boundary layer cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::CLD_BOT = 2 [static]

Cloud bottom

Referenced by toLabel(), and toString().

const int WXP::Level::CLD_CEIL = 215 [static]

Cloud ceiling

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::CLD_TOP = 3 [static]

Cloud top

Referenced by toLabel(), and toString().

const int WXP::Level::CONV_BOT = 242 [static]

Convective cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::CONV_LYR = 244 [static]

Convective cloud layer

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::CONV_TOP = 243 [static]

Convective cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::DCCLD_BOT = 251 [static]

Deep convect cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::DCCLD_TOP = 252 [static]

Deep convect cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::EQUILIB = 247 [static]

Equilibrium level

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::ETA = 111 [static]

Eta level

Referenced by decode(), and toLevelCode().

const int WXP::Level::FRZ = 4 [static]

Freezing level

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::GSCLD_BOT = 206 [static]

Grid scale layer cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::GSCLD_TOP = 207 [static]

Grid scale layer cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::HAG = 103 [static]

Height above ground level

Referenced by decode(), isHght(), WXP::GribFile::readPDB(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::HBG = 106 [static]

Height below ground level

Referenced by decode(), WXP::GribFile::readPDB(), WXP::GribFile::readPDS(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::HCLD_BOT = 232 [static]

High cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::HCLD_LYR = 234 [static]

High cloud layer

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::HCLD_TOP = 233 [static]

High cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::HT = 102 [static]

Height level

Referenced by decode(), getLower(), isHght(), WXP::GribFile::readPDB(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::HYB = 105 [static]

Hybrid level

Referenced by decode(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::LCL = 5 [static]

LCL level

Referenced by WXP::SfcDataTool::compute(), decode(), toLabel(), and toString().

const int WXP::Level::LCLD_BOT = 212 [static]

Low cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::LCLD_LYR = 214 [static]

Low cloud layer

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::LCLD_TOP = 213 [static]

Low cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::MAXEPOT = 246 [static]

Maximum equiv potential temp level

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::MCLD_BOT = 222 [static]

Middle cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::MCLD_LYR = 224 [static]

Middle cloud layer

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::MCLD_TOP = 223 [static]

Middle cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::MISC = 199 [static]

Misc level

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::MSL = 101 [static]

Mean sea level

Referenced by decode(), WXP::GribFile::readPDB(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::MWND = 6 [static]

Maximum wind level

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::PAG = 108 [static]

Pressure above ground level

Referenced by decode(), isPres(), WXP::GribFile::readPDB(), WXP::GribFile::readPDS(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::PBL = 220 [static]

Planetary boundary layer

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::POT = 107 [static]

Potential temperature level

Referenced by decode(), getLower(), isPot(), WXP::GribFile::readPDB(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::POT_VORT = 109 [static]

Potential vorticty level

Referenced by decode(), WXP::GribFile::readPDS(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::PR = 100 [static]

Pressure level

Referenced by decode(), getLower(), isPres(), WXP::GribFile::readPDB(), WXP::GribFile::readPDS(), set(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::SCCLD_BOT = 248 [static]

Shallow convect cloud bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::SCCLD_TOP = 249 [static]

Shallow convect cloud top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::SCLW_BOT = 253 [static]

Supercool liquid water bottom

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::SCLW_TOP = 254 [static]

Supercool liquid water top

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::SEABOT = 9 [static]

Sea bottom

const int WXP::Level::SFC = 1 [static]

Surface

Referenced by WXP::SfcDataTool::compute(), decode(), isPres(), WXP::GribFile::readPDS(), toLabel(), and toString().

const int WXP::Level::SIG = 104 [static]

Sigma level

Referenced by decode(), WXP::GribFile::readPDB(), set(), toLabel(), toLevelCode(), and toString().

const int WXP::Level::SND = 0 [static]

Whole sounding

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::TOP = 8 [static]

Top of atmosphere

Referenced by toLabel(), and toString().

const int WXP::Level::TOP_FRZ = 204 [static]

Top freezing level

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::TROP = 7 [static]

Tropopause

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::WBZERO = 245 [static]

Wet bulb zero

Referenced by decode(), toLabel(), and toString().

const int WXP::Level::WHOLE = 200 [static]

Whole atmosphere

Referenced by decode(), toLabel(), toLevelCode(), and toString().

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

Level.h
Level.cc

WXP::Level Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation