This class plots gridpoint data. More...

#include "../include/GridPlot.h"

Inheritance diagram for WXP::GridPlot:

Public Member Functions
	GridPlot (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	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	getDate (Date &date)

int	getInitDate (Date &date)

int	getDateOffset ()

int	getLoopType ()

int	getNumFrames ()

int	setModel (const char *str)

int	setMap (bool 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	setVariable (const char *str)

bool	isTypeFill ()

int	setMapFill (int val)

int	getDomain (Domain &domain)

int	getSync ()

int	draw (Plot &plot, Grid &grid)

int	draw (Plot &plot)

int	print ()

virtual int	init ()=0

virtual int	getDomain (Domain &domain)=0

virtual int	setFile ()=0

virtual int	setInput (const char *type)=0

virtual int	setNameConv (const char *name)=0

virtual int	setFilename ()=0

virtual int	setFilename (const char *file)=0

virtual int	setFilename (Date &date)=0

virtual int	setFilename (Date &date, const char *param)=0

virtual int	setForeTime (const char *fore)=0

virtual int	setParam (const char *str)=0

virtual int	getDate (Date &date)=0

virtual int	getLoopType ()=0

virtual int	getInitDate (Date &date)=0

virtual int	getDateOffset ()=0

virtual int	getNumFrames ()=0

virtual int	getSync ()=0

virtual int	draw (Plot &plot)=0

virtual int	print ()=0

virtual void	callback (const char ev_str, const char ev_data, const void *data)=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 gridpoint data.

Author: Dan Vietor

Member Function Documentation

◆ callback()

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

virtual

Event callback

Implements WXP::Listener.

◆ draw()

int GridPlot::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::MapPlot::draw(), WXP::String::get(), WXP::VarName::get(), WXP::Filename::getDate(), WXP::ForeTime::getFore(), WXP::Filename::getName(), WXP::GridCont::init(), WXP::GridSpec::init(), WXP::GridVect::init(), WXP::VarSpec::init(), WXP::Wxp::isDebug(), WXP::ForeTime::isSet(), WXP::Wxp::outDebug(), WXP::Wxp::outMessage(), WXP::VarList::print(), WXP::VarSpec::set(), WXP::Filename::setFile(), WXP::Plot::setFill(), WXP::MapPlot::setFillCont(), WXP::Grid::setInfo(), WXP::Plot::setLine(), WXP::Plot::setMark(), WXP::GridCont::setParam(), WXP::GridVect::setParam(), WXP::MapPlot::setParam(), WXP::Plot::setText(), WXP::VarSpec::toInfoLabel(), WXP::GridMath::units(), WXP::String::valid(), and WXP::StrLib::valid().

◆ getDate()

int GridPlot::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int GridPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

◆ getDomain()

int GridPlot::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::DomainTool::decode(), WXP::Grid::getDomain(), WXP::Filename::getName(), WXP::GridFile::isOpen(), WXP::FileTool::isStdio(), WXP::FileAttr::READ, WXP::GridFile::read(), and WXP::Filename::setFile().

◆ getInitDate()

int GridPlot::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().

◆ getLoopType()

int GridPlot::getLoopType ( )

virtual

Gets the available loop types

Returns: Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE, WXP::Drawing::LOOP_FORE, and WXP::String::occurs().

◆ getNumFrames()

int GridPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles(), and WXP::String::occurs().

◆ getSync()

int WXP::GridPlot::getSync ( )

inlinevirtual

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

Returns: Number of frames

Implements WXP::Drawing.

◆ init()

int GridPlot::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References WXP::GridCont::init(), WXP::String::init(), WXP::String::set(), setFile(), setForeTime(), WXP::Filename::setNumFiles(), and setParam().

◆ print()

int GridPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColorFill()

int GridPlot::setColorFill ( const char * str )

Sets the color fill parameters

Parameters

str	Color fill string

References WXP::String::set().

◆ setColorTable()

int GridPlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters

str	Color table parameter

References WXP::String::set().

◆ setFile()

int GridPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::ModelSpec::getName(), WXP::ModelSpec::set(), and setNameConv().

Referenced by init().

◆ setFilename() [1/4]

int GridPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::String::get(), WXP::ForeTime::getFore(), WXP::ForeTime::isSet(), and WXP::Filename::setFile().

◆ setFilename() [2/4]

int GridPlot::setFilename ( const char * str )

virtual

Sets the filename to be used.

Parameters

str	The filename to use

Implements WXP::Drawing.

References WXP::String::get(), WXP::ForeTime::getFore(), WXP::ForeTime::isSet(), and WXP::Filename::setFile().

◆ setFilename() [3/4]

int GridPlot::setFilename ( Date & date )

virtual

Sets the filename to use based on a specific date

Parameters

date	Date to use

Implements WXP::Drawing.

References WXP::String::get(), WXP::ForeTime::getFore(), WXP::ForeTime::isSet(), and WXP::Filename::setFile().

◆ setFilename() [4/4]

int GridPlot::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.

References WXP::String::get(), WXP::ForeTime::getFore(), WXP::ForeTime::isSet(), and WXP::Filename::setFile().

◆ setForeTime()

int GridPlot::setForeTime ( const char * str )

virtual

Sets the forecast time to be used.

Parameters

str	The forecast time

Implements WXP::Drawing.

References WXP::String::append(), and WXP::String::set().

Referenced by init(), and setParam().

◆ setInput()

int GridPlot::setInput ( const char * type )

virtual

Sets the file input file type

Parameters

type	The file type

Implements WXP::Drawing.

◆ setModel()

int GridPlot::setModel ( const char * str )

Sets the model type to be used.

Parameters

str	The model name

References WXP::StrLib::copy(), WXP::ModelSpec::getName(), WXP::ModelSpec::set(), and WXP::Filename::setNameConv().

◆ setNameConv()

int GridPlot::setNameConv ( const char * name )

virtual

Sets the file name convention

Parameters

name	The optional name convention

Implements WXP::Drawing.

References WXP::ModelSpec::getName(), WXP::ModelSpec::set(), WXP::Filename::setNameConv(), and WXP::StrLib::valid().

Referenced by setFile(), and setParam().

◆ setParam()

int GridPlot::setParam ( const char * str )

virtual

Sets specific parameters for the plot given a string

Parameters

str	String specifying parameters

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::ModelSpec::getName(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::ModelSpec::set(), WXP::String::set(), WXP::Timezone::set(), setForeTime(), setNameConv(), WXP::GridCont::setParam(), and WXP::GridVect::setParam().

Referenced by init().

◆ setVariable()

int GridPlot::setVariable ( const char * str )

Sets the variable to be plotted

Parameters

str	Variable string

References WXP::String::set().

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

GridPlot.h
GridPlot.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ callback()

◆ draw()

◆ getDate()

◆ getDateOffset()

◆ getDomain()

◆ getInitDate()

◆ getLoopType()

◆ getNumFrames()

◆ getSync()

◆ init()

◆ print()

◆ setColorFill()

◆ setColorTable()

◆ setFile()

◆ setFilename() [1/4]

◆ setFilename() [2/4]

◆ setFilename() [3/4]

◆ setFilename() [4/4]

◆ setForeTime()

◆ setInput()

◆ setModel()

◆ setNameConv()

◆ setParam()

◆ setVariable()