This class plots surface data. More...

#include "../include/SfcPlot.h"

Inheritance diagram for WXP::SfcPlot:

Public Member Functions
	SfcPlot ()

	SfcPlot (const char *param)

int	init ()

int	setParam (const char *str)

int	setPath (const char *path)

int	setFile ()

int	setInput (const char *str)

int	setNameConv (const char *name)

int	setHour (const char *str)

int	setFilename ()

int	setFilename (Date &date)

int	setFilename (const char *str)

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

int	setForeTime (const char *fore)

int	setColorTable (const char *str)

int	setColor (const char *str)

int	setVariable (const char *str)

int	setPlotType (const char *str)

int	setTimezone (const char *str)

int	setGridDomain (const char *str)

int	setOutput (const char *file)

int	setMap (bool val)

int	getDate (Date &date)

int	getInitDate (Date &date)

int	getDateOffset ()

int	getLoopType ()

int	getNumFrames ()

int	getDomain (Domain &domain)

int	getSync ()

int	draw (Plot &plot)

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

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 surface data.

This class will read in a decoded surface data file and plot data to a plot object. The data is read in, either plotted directly or fit to a grid and contoured.

syntax:
SfcPlot splot;
splot.setParam( "parameters,..." );
splot.setFilename();
splot.setVariable( "variable" );
splot.draw( plot );

Author: Dan Vietor

Constructor & Destructor Documentation

◆ SfcPlot() [1/2]

SfcPlot::SfcPlot ( )

Constructor. Initializes class

References init().

◆ SfcPlot() [2/2]

SfcPlot::SfcPlot ( const char * param )

Constructor. Initializes class and sets parameters

Parameters

param The parameters to set

References init(), and setParam().

Member Function Documentation

◆ callback()

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

virtual

Sets the callback for processing data from display

Parameters

ev_str	The event type
ev_data	The event data such as cursor location
data	The user defined data attached to event

Implements WXP::Listener.

◆ draw()

int SfcPlot::draw ( Plot & plot )

virtual

Plots the surface data

Parameters

plot	The plot object to draw to

Implements WXP::Drawing.

References WXP::Plot::addLabel(), WXP::String::append(), WXP::ContPlot::BOTH, WXP::String::clear(), WXP::SfcGrid::compute(), WXP::SfcDataTool::compute(), WXP::StrLib::copy(), WXP::ContPlot::decodeType(), WXP::MapPlot::draw(), WXP::DatumPlot::draw(), WXP::StrLib::equal(), WXP::ContPlot::FILL, WXP::String::get(), WXP::SfcFile::getDate(), WXP::Filename::getName(), WXP::SfcDataTool::getUnits(), WXP::Datum::init(), WXP::GridCont::init(), WXP::GridSpec::init(), WXP::GridVect::init(), WXP::VarSpec::init(), WXP::Wxp::isDebug(), WXP::Domain::isSet(), WXP::ContPlot::LINE, WXP::Wxp::outDebug(), WXP::Wxp::outMessage(), WXP::VarList::print(), WXP::FileAttr::READ, WXP::SfcFile::read(), WXP::StrLib::replace(), WXP::SfcFile::rewind(), 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::SfcGrid::setVariable(), WXP::VarSpec::toInfoLabel(), WXP::GridMath::units(), WXP::StrLib::valid(), and WXP::ContPlot::VALUE.

◆ getDate()

int SfcPlot::getDate ( Date & date )

virtual

Gets the date information from the input file

Return values

date	The file date

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int SfcPlot::getDateOffset ( )

virtual

Gets the date offset from name convention for loops

Returns: The offset in seconds

Implements WXP::Drawing.

◆ getDomain()

int SfcPlot::getDomain ( Domain & domain )

virtual

Gets the default domain

Return values

domain The default domain

Implements WXP::Drawing.

References WXP::DomainTool::set().

◆ getInitDate()

int SfcPlot::getInitDate ( Date & date )

virtual

Gets the date of the initial file (in loops)

Parameters

date	The file date

Implements WXP::Drawing.

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

◆ getLoopType()

int SfcPlot::getLoopType ( )

virtual

Returns the default loop type

Returns: The loop type (date)

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int SfcPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

◆ getSync()

int WXP::SfcPlot::getSync ( )

inlinevirtual

Returns whether object is a time sync

Implements WXP::Drawing.

◆ init()

int SfcPlot::init ( )

virtual

Intializes the class

Implements WXP::Drawing.

References WXP::DatumPlot::init(), WXP::Filename::init(), WXP::GridCont::init(), WXP::GridVect::init(), WXP::String::init(), WXP::Timezone::init(), setFile(), setGridDomain(), setNameConv(), setOutput(), setParam(), setPlotType(), setTimezone(), and setVariable().

Referenced by SfcPlot(), and SfcPlot().

◆ print()

int SfcPlot::print ( )

virtual

Prints class information

Implements WXP::Drawing.

References WXP::String::get(), WXP::Domain::print(), WXP::Filename::print(), and WXP::Timezone::print().

◆ setColor()

int SfcPlot::setColor ( const char * str )

Sets the color parameters

Parameters

str	Color string

References WXP::DatumPlot::setAttr().

Referenced by setParam().

◆ setColorTable()

int SfcPlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters

str	Color table parameter

References WXP::DatumPlot::setColorTable(), WXP::GridCont::setColorTable(), and WXP::GridVect::setColorTable().

Referenced by setParam().

◆ setFile()

int SfcPlot::setFile ( )

virtual

Sets up the file parameters

Implements WXP::Drawing.

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

Referenced by init().

◆ setFilename() [1/4]

int SfcPlot::setFilename ( )

virtual

Sets the input file name

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [2/4]

int SfcPlot::setFilename ( const char * str )

virtual

Sets a specific file name

Parameters

str	The filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/4]

int SfcPlot::setFilename ( Date & date )

virtual

Sets the input file date. The file name is derived using name convention

Parameters

date	The file date

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/4]

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

virtual

Sets the input file date with parameters. This is passed to the name convention to set file name

Parameters

date	The file date
param	The name convention parameters

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setForeTime()

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

inlinevirtual

Sets the forecast time (ignored)

Implements WXP::Drawing.

◆ setGridDomain()

int SfcPlot::setGridDomain ( const char * str )

Sets the grid domain (the domain data is fit to grid)

Parameters

str Domain

References WXP::DomainTool::decode().

Referenced by init().

◆ setHour()

int SfcPlot::setHour ( const char * str )

Sets the specific file time

Parameters

str	The file time (hour)

References WXP::Filename::setFixDate().

Referenced by setFile(), and setParam().

◆ setInput()

int SfcPlot::setInput ( const char * str )

virtual

Sets the input file type

Parameters

str	The file type

Implements WXP::Drawing.

Referenced by setFile().

◆ setMap()

int WXP::SfcPlot::setMap ( bool val )

inline

Sets whether object is to draw map or not

Referenced by setParam().

◆ setNameConv()

int SfcPlot::setNameConv ( const char * name )

virtual

Sets the file name convention

Parameters

name	The name convention

Implements WXP::Drawing.

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

Referenced by init(), setFile(), and setParam().

◆ setOutput()

int SfcPlot::setOutput ( const char * file )

Sets the vector skip. Used to thin out vectors in dense grids

Parameters

val	Skip factor

References WXP::String::set().

Referenced by init().

◆ setParam()

int SfcPlot::setParam ( const char * str )

virtual

Sets the parameters within the class:

Parameters

str String to parse
ct=file - Color table file
co=color - Plotting color
va=var - Variable to plot
if=var - Input file name convention
nc=var - Input file name convention
ho=hour - Fix date parameters (ie hour of day)
tz=zone - Zone information for label
pl=type - Plot type (data, cf, ln, etc)
map - Plots a map
map_line - Plots a map with line contour settings
map_fill - Plots a map with fill contour settings
sync - Specifes object as time sync

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::String::set(), setColor(), setColorTable(), setHour(), setMap(), setNameConv(), WXP::DatumPlot::setParam(), WXP::GridCont::setParam(), WXP::GridVect::setParam(), setPlotType(), setTimezone(), and setVariable().

Referenced by init(), and SfcPlot().

◆ setPath()

int SfcPlot::setPath ( const char * path )

Sets the input file path

Parameters

path	The file path

References WXP::Filename::setPath().

◆ setPlotType()

int SfcPlot::setPlotType ( const char * str )

Sets the plot type

Parameters

str	Type (data, ln, cf, lcf, gvalue)

References WXP::StrLib::copy().

Referenced by init(), and setParam().

◆ setTimezone()

int SfcPlot::setTimezone ( const char * str )

Sets the timezone for dates

Parameters

str Zone

References WXP::Timezone::set().

Referenced by init(), and setParam().

◆ setVariable()

int SfcPlot::setVariable ( const char * str )

Sets the variable to be plotted

Parameters

str	Variable string

References WXP::String::set().

Referenced by init(), and setParam().

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

SfcPlot.h
SfcPlot.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SfcPlot() [1/2]

◆ SfcPlot() [2/2]

Member Function Documentation

◆ callback()

◆ draw()

◆ getDate()

◆ getDateOffset()

◆ getDomain()

◆ getInitDate()

◆ getLoopType()

◆ getNumFrames()

◆ getSync()

◆ init()

◆ print()

◆ setColor()

◆ setColorTable()

◆ setFile()

◆ setFilename() [1/4]

◆ setFilename() [2/4]

◆ setFilename() [3/4]

◆ setFilename() [4/4]

◆ setForeTime()

◆ setGridDomain()

◆ setHour()

◆ setInput()

◆ setMap()

◆ setNameConv()

◆ setOutput()

◆ setParam()

◆ setPath()

◆ setPlotType()

◆ setTimezone()

◆ setVariable()