WXP C++ Library: WXP::UpaPlot Class Reference

WXP C++ Library Version 6.74.9

Loading...

Searching...

No Matches

This class plots upper air data. More...

#include "../include/UpaPlot.h"

Inheritance diagram for WXP::UpaPlot:

Public Member Functions
	UpaPlot ()
	UpaPlot (const char *param)
int	init ()
int	setParam (const char *str)
int	setPath (const char *path)
int	setFile ()
int	setInput (const char *type)
int	setNameConv (const char *name)
int	setHour (const char *str)
int	setFilename ()
int	setFilename (const char *str)
int	setFilename (Date &date)
int	setFilename (Date &date, const char *param)
int	setForeTime (const char *fore)
int	setColorTable (const char *str)
int	setColor (const char *str)
int	setVariable (const char *str)
int	setLevel (const char *str)
int	setPlotType (const char *str)
int	setTimezone (const char *str)
int	setGridDomain (const char *str)
int	setMap (bool val)
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	getDomain (Domain &domain)
int	getSync ()
int	draw (Plot &plot)
void	callback (const char ev_str, const char ev_data, const void *data)
int	print ()

Additional Inherited Members
Static Public Attributes inherited from WXP::Drawing
static const int	LOOP_NONE = 0
static const int	LOOP_DATE = 1
static const int	LOOP_FORE = 2

Detailed Description

This class plots upper air data.

This class will read in a decoded upper air data file and plot data to a plot object. The data is read in, either plotted directly or fit to a grid and contoured.

syntax:
UpaPlot uplot;
uplot.setParam( "parameters,..." );
uplot.setFilename();
uplot.setLevel( "level" );
uplot.setVariable( "variable" );
uplot.draw( plot );

Author: Dan Vietor

Constructor & Destructor Documentation

◆ UpaPlot() [1/2]

UpaPlot::UpaPlot ( )

Constructor. Initializes class

References init().

◆ UpaPlot() [2/2]

UpaPlot::UpaPlot ( const char * param )

Constructor. Initializes class and sets parameters

Parameters

param The parameters to set

References init(), and setParam().

Member Function Documentation

◆ callback()

void UpaPlot::callback	(	const char *	ev_str,
		const char *	ev_data,
		const void *	data )

virtual

The event callback

Parameters

ev_str	String containing description of event
ev_data	Event specific data
data	User specific data

Implements WXP::Listener.

◆ draw()

int UpaPlot::draw ( Plot & plot )

virtual

Plots the surface data

Parameters

plot	The plot object to draw to

Implements WXP::Drawing.

References WXP::Plot::addLabel(), WXP::String::append(), WXP::ContPlot::BOTH, WXP::String::clear(), WXP::UpaDataTool::compute(), WXP::StrLib::copy(), WXP::ContPlot::decodeType(), WXP::MapPlot::draw(), WXP::ContPlot::FILL, WXP::String::get(), WXP::UpaFile::getDate(), WXP::UpaDataTool::getUnits(), WXP::Datum::init(), WXP::GridSpec::init(), WXP::UpaData::init(), WXP::VarSpec::init(), WXP::Wxp::isDebug(), WXP::ContPlot::LINE, WXP::Const::MISS, WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::VarList::print(), WXP::FileAttr::READ, WXP::UpaFile::read(), WXP::StrLib::replace(), WXP::Level::set(), WXP::VarSpec::set(), WXP::Plot::setFill(), WXP::MapPlot::setFillCont(), WXP::Grid::setInfo(), WXP::Plot::setLine(), WXP::Plot::setMark(), WXP::MapPlot::setParam(), WXP::Plot::setText(), WXP::VarSpec::toInfoLabel(), WXP::GridMath::units(), WXP::StrLib::valid(), and WXP::ContPlot::VALUE.

◆ getDate()

int UpaPlot::getDate ( Date & date )

virtual

Gets the date information from the input file

Return values

date	Date values

Implements WXP::Drawing.

◆ getDateOffset()

int UpaPlot::getDateOffset ( )

virtual

Gets the date offset from name convention for loops

Returns: The offset in seconds

Implements WXP::Drawing.

◆ getDomain()

int UpaPlot::getDomain ( Domain & domain )

virtual

Gets the default domain

Return values

domain The default domain

Implements WXP::Drawing.

References WXP::DomainTool::set().

◆ getInitDate()

int UpaPlot::getInitDate ( Date & date )

virtual

Gets the date of the initial file (in loops)

Parameters

date	The file date

Implements WXP::Drawing.

◆ getLoopType()

int UpaPlot::getLoopType ( )

virtual

Returns the default loop type

Returns: The loop type (date)

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int UpaPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::UpaPlot::getSync ( )

inlinevirtual

Tells whether an object should be used to sync other to it

Returns: Number of frames

Implements WXP::Drawing.

◆ init()

int UpaPlot::init ( )

virtual

Intializes the class

Implements WXP::Drawing.

References setFile(), setGridDomain(), setLevel(), setNameConv(), setParam(), setPlotType(), setTimezone(), and setVariable().

Referenced by UpaPlot(), and UpaPlot().

◆ print()

int UpaPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColor()

int UpaPlot::setColor ( const char * str )

Sets the color parameters

Parameters

str Color string

Referenced by setParam().

◆ setColorTable()

int UpaPlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters

str Color table parameter

Referenced by setParam().

◆ setFile()

int UpaPlot::setFile ( )

virtual

Sets the default file parameters

Implements WXP::Drawing.

References setHour(), setInput(), and setNameConv().

Referenced by init().

◆ setFilename() [1/4]

int UpaPlot::setFilename ( )

virtual

Sets the input file name

Implements WXP::Drawing.

◆ setFilename() [2/4]

int UpaPlot::setFilename ( const char * str )

virtual

Sets a specific file name

Parameters

str	The filename to use

Implements WXP::Drawing.

◆ setFilename() [3/4]

int UpaPlot::setFilename ( Date & date )

virtual

Sets the input file date. The file name is derived using name convention

Parameters

date	The file date

Implements WXP::Drawing.

◆ setFilename() [4/4]

int UpaPlot::setFilename	(	Date &	date,
		const char *	param )

virtual

Sets the input file date with parameters. This is passed to the name convention to set file name

Parameters

date	The file date
param	The name convention parameters

Implements WXP::Drawing.

◆ setForeTime()

int WXP::UpaPlot::setForeTime ( const char * fore )

inlinevirtual

Sets the forecast time (ignored)

Implements WXP::Drawing.

◆ setGridDomain()

int UpaPlot::setGridDomain ( const char * str )

Sets the grid domain (the domain data is fit to grid)

Parameters

str Domain

References WXP::DomainTool::decode().

Referenced by init().

◆ setHour()

int UpaPlot::setHour ( const char * str )

Sets the specific file time

Parameters

str	The file time (hour)

Referenced by setFile(), and setParam().

◆ setInput()

int UpaPlot::setInput ( const char * str )

virtual

Sets the input file type

Parameters

str	The file type

Implements WXP::Drawing.

Referenced by setFile().

◆ setLevel()

int UpaPlot::setLevel ( const char * str )

Sets the level to be plotted

Parameters

str	Level string

Referenced by init(), and setParam().

◆ setMap()

int WXP::UpaPlot::setMap ( bool val )

inline

Sets whether object is to draw map or not

Referenced by setParam().

◆ setNameConv()

int UpaPlot::setNameConv ( const char * name )

virtual

Sets the file name convention

Parameters

name	The name convention

Implements WXP::Drawing.

Referenced by init(), setFile(), and setParam().

◆ setParam()

int UpaPlot::setParam ( const char * str )

virtual

Sets the parameters within the class:

Parameters

str String to parse
ct=file - Color table file
co=color - Plotting color
le=var - Level to plot
va=var - Variable to plot
if=var - Input file name convention
nc=var - Input file name convention
ho=hour - Fix date parameters (ie hour of day)
tz=zone - Zone information for label
pl=type - Plot type (data, cf, ln, etc)
map - Plots a map map_line - Plots a map with line contour settings map_fill - Plots a map with fill contour settings sync - Specifes object as time sync

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), setColor(), setColorTable(), setHour(), setLevel(), setMap(), setNameConv(), setPlotType(), setTimezone(), and setVariable().

Referenced by init(), and UpaPlot().

◆ setPath()

int UpaPlot::setPath ( const char * path )

Sets the input file path

Parameters

path	The file path

◆ setPlotType()

int UpaPlot::setPlotType ( const char * str )

Sets the plot type

Parameters

str	Type (data, ln, cf, lcf, gvalue)

References WXP::StrLib::copy().

Referenced by init(), and setParam().

◆ setTimezone()

int UpaPlot::setTimezone ( const char * str )

Sets the timezone for dates

Parameters

str Zone

Referenced by init(), and setParam().

◆ setVariable()

int UpaPlot::setVariable ( const char * str )

Sets the variable to be plotted

Parameters

str	Variable string

Referenced by init(), and setParam().

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

UpaPlot.h
UpaPlot.cc