WXP::GridCont Class Reference

This class plots gridpoint data. More...

#include "../include/GridCont.h"

Inheritance diagram for WXP::GridCont:

Public Member Functions
	GridCont (const char *param)
int	init ()
int	setParam (const char *str)
int	setPath (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	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	setModel (const char *str)
int	setLabel (int val)
void	callback (const char *ev_str, const char *ev_data, const void *data)
int	setColorTable (const char *str)
int	setColorFill (const char *str)
int	setType (int type)
int	setBase (float val)
int	setInterval (float val)
int	setLabelParam (int skip, int rad)
int	setMap (bool val)
int	setMapFill (int val)
bool	isTypeFill ()
int	getDomain (Domain &domain)
int	getSync ()
int	draw (Plot &plot, Grid &grid)
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 gridpoint data.

Author

Dan Vietor

Member Function Documentation

callback()

void GridCont::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 GridCont::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::getDate(), WXP::Filename::getName(), WXP::Const::MISS, WXP::Wxp::outMessage(), and WXP::GridSpec::set().

getDate()

int GridCont::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

getDateOffset()

int GridCont::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

getDomain()

int GridCont::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::DomainTool::decode(), WXP::String::get(), WXP::GridFile::isOpen(), WXP::FileTool::isStdio(), and WXP::FileAttr::READ.

getInitDate()

int GridCont::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

getLoopType()

int GridCont::getLoopType ( )

virtual

Gets the available loop types

Returns

Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

getNumFrames()

int GridCont::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns

Number of frames

Implements WXP::Drawing.

getSync()

int WXP::GridCont::getSync ( )

inlinevirtual

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

Returns

Number of frames

Implements WXP::Drawing.

init()

int GridCont::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References setFile(), setModel(), and setParam().

print()

int GridCont::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

setColorFill()

int GridCont::setColorFill

(

const char *

str

)

Sets the color fill parameters

Parameters

str	Color fill string

setColorTable()

int GridCont::setColorTable

(

const char *

str

)

Sets the color table parameters

Parameters

str	Color table parameter

setFile()

int GridCont::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setNameConv().

Referenced by init().

setFilename() [1/4]

int GridCont::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

setFilename() [2/4]

int GridCont::setFilename ( const char * str )

virtual

Sets the filename to be used.

Parameters

str	The filename to use

Implements WXP::Drawing.

setFilename() [3/4]

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

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

setInput()

int GridCont::setInput ( const char * type )

virtual

Sets the file input file type

Parameters

type	The file type

Implements WXP::Drawing.

setModel()

int GridCont::setModel

(

const char *

str

)

Sets the model type to be used.

Parameters

str	The model name

References WXP::StrLib::copy().

Referenced by init(), and setParam().

setNameConv()

int GridCont::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 GridCont::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::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::iequal(), and setModel().

Referenced by init().

---

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

• GridCont.h
• GridCont.cc