WXP::NidsPlot Class Reference
[Plotting objects]

This class plots NIDS data. More...

#include "../include/NidsPlot.h"

Inheritance diagram for WXP::NidsPlot:

Public Member Functions
	NidsPlot ()
	NidsPlot (const char *str)
int	init ()
int	setParam (const char *str)
int	setPath (const char *path)
int	setFile ()
int	setInput (const char *type)
int	setNameConv (const char *type)
int	setHour (const char *str)
int	setFilename ()
int	setFilename (Filename &rfile)
int	setFilename (const char *file)
int	setFilename (Date &date)
int	setFilename (Date &date, const char *param)
int	setForeTime (const char *fore)
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	getDomain (Domain &domain)
int	getInfo (NidsInfo &rinfo)
int	setId (const char *str)
int	setType (const char *str)
int	setVariable (const char *str)
int	setColorTable (const char *str)
int	setColorFill (const char *str)
int	setColor (const char *str)
int	setMap (bool val)
int	getSync ()
int	drawImage (Plot &plot)
int	drawData (Plot &plot)
const char *	getUnits (const char *name)
int	drawStorm (Plot &plot, StormAttr &storm)
int	draw (Plot &plot)
void	callback (const char ev_str, const char ev_data, const void *data)
int	print ()

Detailed Description

This class plots NIDS data.

Author:: Dan Vietor

Constructor & Destructor Documentation

NidsPlot::NidsPlot ( )

Constructor. Initializes class data

Member Function Documentation

void NidsPlot::callback	(	const char *	ev_str,
		const char *	ev_data,
		const void *	data
	)			`[virtual]`

Event callback

Implements WXP::Listener.

int NidsPlot::draw ( Plot & plot ) [virtual]

Draws the NIDS plot

Parameters:

plot

The plot class to draw to

Implements WXP::Drawing.

References WXP::MapPlot::draw(), drawData(), WXP::String::get(), WXP::Filename::getName(), WXP::NidsFile::isOpen(), WXP::NidsFile::open(), WXP::Wxp::outMessage(), WXP::Wxp::outWarning(), WXP::Filename::setFile(), and WXP::String::valid().

Referenced by WXP::RadPlot::draw().

int NidsPlot::drawData ( Plot & plot )

Draws the NIDS plot

Parameters:

plot

The plot class to draw to

References WXP::Plot::addLabel(), WXP::DomainVal::clat, WXP::DomainVal::clon, WXP::Plot::drawCircle(), WXP::Plot::drawLine(), WXP::Plot::drawMark(), WXP::Plot::drawText(), WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::String::get(), WXP::NidsFile::getVector(), WXP::NidsInfo::lat, WXP::NidsInfo::lon, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::Wxp::outMessage(), WXP::Domain::PIXEL, WXP::DomainVal::proj, WXP::EarthPoint::set(), WXP::Domain::set(), WXP::Plot::setFill(), WXP::Plot::setLine(), WXP::Plot::setMark(), WXP::Plot::setText(), WXP::VarSpec::toInfoLabel(), WXP::StrLib::valid(), and WXP::String::valid().

Referenced by draw().

int NidsPlot::getDate ( Date & date ) [virtual]

Gets the date information from the input file

Return values:

date

Date values

Implements WXP::Drawing.

References WXP::Filename::getDate().

Referenced by WXP::RadPlot::getDate(), and WXP::RadPlot::getInitDate().

int NidsPlot::getDateOffset ( ) [virtual]

Gets the offset time between frames in loop

Return values:

date

Date information

Implements WXP::Drawing.

Referenced by WXP::RadPlot::getDateOffset().

int NidsPlot::getDomain ( Domain & domain ) [virtual]

Gets the default domain from the data file

Return values:

domain

Output domain

Implements WXP::Drawing.

References WXP::DomainVal::clat, WXP::DomainVal::clon, WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::CityData::getLat(), WXP::CityData::getLon(), WXP::Filename::getName(), WXP::NidsFile::isOpen(), WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::NidsFile::open(), WXP::DomainVal::plat, WXP::DomainVal::plon, WXP::Domain::print(), WXP::DomainVal::proj, WXP::Domain::PSTEREO, WXP::CityTool::search(), WXP::Domain::set(), WXP::NidsInfo::src, and WXP::StrLib::valid().

Referenced by WXP::RadPlot::getDomain().

int NidsPlot::getInitDate ( Date & date ) [virtual]

Gets the initial date for a loop

Return values:

date

Date information

Implements WXP::Drawing.

References WXP::Filename::getDate(), and WXP::Filename::setFile().

int NidsPlot::getLoopType ( ) [virtual]

Gets the available loop types

Returns:: Loop type

Implements WXP::Drawing.

int NidsPlot::getNumFrames ( ) [virtual]

Gets the possible number of frames in a loop

Returns:: Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

Referenced by WXP::RadPlot::getNumFrames().

int WXP::NidsPlot::getSync ( ) [inline, virtual]

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

Returns:: Number of frames

Implements WXP::Drawing.

int NidsPlot::print ( ) [virtual]

Method for printing class info

Implements WXP::Drawing.

References WXP::String::get(), and WXP::Filename::getName().

int NidsPlot::setColor ( const char * str )

Sets the color parameters for data plotting

Parameters:

str

Color string

References WXP::String::set().

Referenced by WXP::RadPlot::setColor().

int NidsPlot::setColorFill ( const char * str )

Sets the color fill parameters

Parameters:

str

Color fill string

References WXP::String::set().

Referenced by WXP::RadPlot::setColorFill(), and setParam().

int NidsPlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters:

str

Color table parameter

References WXP::String::set().

Referenced by WXP::RadPlot::setColorTable(), and setParam().

int NidsPlot::setFile ( ) [virtual]

Sets the file parameters such as input file type

Implements WXP::Drawing.

References setInput(), setNameConv(), and WXP::Filename::setNumFiles().

int NidsPlot::setFilename	(	Date &	date,
		const char *	param
	)			`[virtual]`

Sets the filename from a date and parameters

Parameters:

	date	Date values to use in setting up filename
	param	Parameters to modify name generation

Implements WXP::Drawing.

References WXP::Filename::setDate().

int NidsPlot::setFilename ( Date & date ) [virtual]

Sets the filename from a Date class.

Parameters:

date

Date values to use in setting up filename

Implements WXP::Drawing.

References WXP::Filename::setDate().

int NidsPlot::setFilename ( const char * str ) [virtual]

Sets the filename to be used.

Parameters:

str

The filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

int NidsPlot::setFilename ( Filename & rfile )

Sets the filename to be used. Prompts the user for the filename

Parameters:

rfile

The filename class

int NidsPlot::setFilename ( ) [virtual]

Sets the filename to be used. Prompts the user for the filename

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

Referenced by WXP::RadPlot::setFilename().

int WXP::NidsPlot::setForeTime ( const char * fore ) [inline, virtual]

Sets specific forecast time to plot

Parameters:

fore

Forecast time

Implements WXP::Drawing.

int NidsPlot::setId ( const char * str )

Sets the station ID

Parameters:

str

Station ID

References WXP::StrLib::copy().

int NidsPlot::setInput ( const char * str ) [virtual]

Sets the input parameters

Parameters:

str

The parameters

Implements WXP::Drawing.

Referenced by setFile().

int NidsPlot::setNameConv ( const char * name ) [virtual]

Sets the file name convention

Parameters:

type

The optional name convention

Implements WXP::Drawing.

References WXP::Filename::setNameConv(), WXP::Filename::setNumFiles(), and WXP::StrLib::valid().

Referenced by setFile(), WXP::RadPlot::setInput(), WXP::RadPlot::setNameConv(), and setParam().

int NidsPlot::setParam ( const char * str ) [virtual]

Sets basic parameters given a string of options

Parameters:

str

String containing parameters
ct=file - Color table file
cof=colors - Color fill colors for NIDS plot
va=var - Variable to plot
if=conv - Input file name convention
nc=conv - Input file name convention
tz=zone - Time zone
pa=path - Input file path
id=site - Radar site ID (goes to i)
ty=type - Radar data type (goes to t)
plot - Draw only plot
data - Draw only text data
site - Plot marker at site
dist=#:#:#:# - Plot distance rings (up to 4 in km)
distm=#:#:#:# - Plot distance rings (up to 4 in nm)
map - Have this object plot the map
nodist - Disable distance rings
table - Plot storm attribute table
notable - Don't plot storm attribute table
clutter - Set clutter radius to 25nm
clutter=# - Set clutter radius to km
noclutter - Disable clutter radius
ramp:db:rng - Sets ramp echo elimination (max dbz and range)

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::Strings::getInt(), WXP::Strings::getLength(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::Convert::NMtoKM(), WXP::Strings::scanf(), setColorFill(), setColorTable(), setNameConv(), setPath(), and setVariable().