WXP::UpaXSectCont Class Reference

This class plots cross sections. More...

#include "../include/UpaXSectCont.h"

Inheritance diagram for WXP::UpaXSectCont:

Public Types
enum	Type { SPATIAL , TIME }

Public Member Functions
int	setParam (const char *str)
int	setFile ()
int	setInput (const char *type)
int	setNameConv (const char *name)
int	setFilename ()
int	setFilename (const char *name)
int	setFilename (Date &date)
int	setFilename (Date &date, const char *param)
int	setForeTime (const char *fore)
int	promptId ()
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	getDomain (Domain &domain)
int	draw (Plot &plot)
void	callback (const char *ev_str, const char *ev_data, const void *data)
int	print ()
Public Member Functions inherited from WXP::Drawing
virtual int	init ()=0
virtual int	getSync ()=0

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 cross sections.

Author

Dan Vietor

Deprecated

Member Function Documentation

callback()

void UpaXSectCont::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 UpaXSectCont::draw ( Plot & plot )

virtual

Method for plotting the actual data

Parameters

plot	The plot class specifying window and parameters for plotting

Implements WXP::Drawing.

References WXP::Plot::addLabel(), WXP::FileTool::addPath(), WXP::Grid::allocData(), WXP::Grid::allocLocate(), WXP::String::append(), WXP::UpaCalc::calc(), WXP::Domain::calcEarthDist(), WXP::ContPlot::draw(), WXP::XSectionPlot::draw(), WXP::Plot::drawLine(), WXP::String::get(), WXP::UpaFile::getDate(), WXP::CityData::getId(), WXP::CityData::getLat(), WXP::CityData::getLon(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::UpaCalc::getUnits(), WXP::StrLib::iequal(), WXP::VarName::makeLabel(), WXP::Const::MISS, WXP::Wxp::outMessage(), WXP::VCoord::PRES, WXP::String::printf(), WXP::CityFile::read(), WXP::UpaFile::read(), WXP::EarthPoint::set(), WXP::Point::set(), WXP::Strings::set(), WXP::VCoord::set(), WXP::ContPlot::setBase(), WXP::Plot::setFill(), WXP::ContPlot::setInterval(), WXP::Plot::setLine(), WXP::Grid::setLocate(), WXP::ContPlot::setParam(), WXP::Grid::setSize(), WXP::Plot::setText(), WXP::ContPlot::setType(), WXP::Grid::setValue(), and WXP::StrLib::toFloat().

getDate()

int UpaXSectCont::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

getDateOffset()

int UpaXSectCont::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

getDomain()

int UpaXSectCont::getDomain ( Domain & domain )

virtual

A method for getting a default domain from the data. This is handy for data types that are for a specific domain like NIDS data.

Return values

domain

Default domain

Implements WXP::Drawing.

References WXP::Domain::init().

getInitDate()

int UpaXSectCont::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

getLoopType()

int UpaXSectCont::getLoopType ( )

virtual

Gets the available loop types

Returns

Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

getNumFrames()

int UpaXSectCont::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns

Number of frames

Implements WXP::Drawing.

print()

int UpaXSectCont::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

setFile()

int UpaXSectCont::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setNameConv().

setFilename() [1/4]

int UpaXSectCont::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

setFilename() [2/4]

int UpaXSectCont::setFilename ( const char * file )

virtual

A method for setting the default file for plotting

Parameters

file	Filename to use

Implements WXP::Drawing.

setFilename() [3/4]

int UpaXSectCont::setFilename ( Date & date )

virtual

Sets the filename to use based on a specific date

Parameters

date	Date to use

Implements WXP::Drawing.

setFilename() [4/4]

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

virtual

Sets the filename to use based on a specific date and parameters

Parameters

date	Date to use
param	Parameters to use for offset to date

Implements WXP::Drawing.

setForeTime()

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

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

setInput()

int UpaXSectCont::setInput ( const char * type )

virtual

A method for setting input file type

Parameters

name	Name convention to use

Implements WXP::Drawing.

setNameConv()

int UpaXSectCont::setNameConv ( const char * name )

virtual

A method for setting input file name convention

Parameters

name	Name convention to use

Implements WXP::Drawing.

Referenced by setFile().

setParam()

int UpaXSectCont::setParam ( const char * str )

virtual

Sets specific parameters for the plot given a string

Parameters

str	String specifying parameters

Implements WXP::Drawing.

References WXP::Strings::getNum().

---

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

• UpaXSectCont.h
• UpaXSectCont.cc