WXP::GridVect Class Reference

This class plots U and V gridpoint data. More...

#include "../include/GridVect.h"

Inheritance diagram for WXP::GridVect:

Public Member Functions
	GridVect (const char *param)
int	init ()
int	setParam (const char *str)
int	setFile ()
int	setInput (const char *type)
int	setNameConv (const char *name)
int	setFilename ()
int	setFilename (const char *str)
int	setFilename (Date &date)
int	setFilename (Date &date, const char *param)
int	setForeTime (const char *fore)
int	getDomain (Domain &domain)
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	setModel (const char *str)
void	callback (const char *ev_str, const char *ev_data, const void *data)
int	setMap (bool val)
int	setLabel (int val)
int	setColorTable (const char *str)
int	setColorFill (const char *str)
float	getMax ()
int	getSync ()
int	draw (Plot &plot, Grid &grid1, Grid &grid2)
int	draw (Plot &plot)
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 U and V gridpoint data.

Author

Dan Vietor

Member Function Documentation

callback()

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

virtual

Event callback

Implements WXP::Listener.

References WXP::StrLib::equal(), and WXP::EarthPoint::set().

draw()

int GridVect::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::Wxp::checkMessage(), WXP::Filename::getName(), WXP::GridSpec::init(), WXP::Wxp::outMessage(), WXP::Filename::setFile(), and WXP::Filename::setName().

getDate()

int GridVect::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

getDateOffset()

int GridVect::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

getDomain()

int GridVect::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::FileTool::addOutPath(), WXP::String::get(), WXP::Grid::getDomain(), WXP::GridFile::isOpen(), and WXP::FileAttr::READ.

getInitDate()

int GridVect::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

getLoopType()

int GridVect::getLoopType ( )

virtual

Gets the available loop types

Returns

Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

getNumFrames()

int GridVect::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns

Number of frames

Implements WXP::Drawing.

getSync()

int WXP::GridVect::getSync ( )

inlinevirtual

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

Returns

Number of frames

Implements WXP::Drawing.

init()

int GridVect::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References setParam().

print()

int GridVect::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

setColorFill()

int GridVect::setColorFill

(

const char *

str

)

Sets the color fill parameters

Parameters

str	Color fill string

setColorTable()

int GridVect::setColorTable

(

const char *

str

)

Sets the color table parameters

Parameters

str	Color table parameter

setFile()

int GridVect::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setNameConv().

setFilename() [1/4]

int GridVect::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

setFilename() [2/4]

int GridVect::setFilename ( const char * str )

virtual

Sets the filename to be used.

Parameters

str	The filename to use

Implements WXP::Drawing.

setFilename() [3/4]

int GridVect::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 GridVect::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::GridVect::setForeTime ( const char * fore )

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

setInput()

int GridVect::setInput ( const char * type )

virtual

Sets the file input file type

Parameters

type	The file type

Implements WXP::Drawing.

setModel()

int GridVect::setModel

(

const char *

str

)

Sets the model type to be used.

Parameters

str	The model name

References WXP::StrLib::copy().

setNameConv()

int GridVect::setNameConv ( const char * name )

virtual

Sets the file name convention

Parameters

name	The optional name convention

Implements WXP::Drawing.

References WXP::StrLib::valid().

Referenced by setFile().

setParam()

int GridVect::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(), and WXP::Strings::iequal().

Referenced by init().

---

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

• GridVect.h
• GridVect.cc