WXP::MeteoPlot Class Reference

This class plots a time series meteogram. This can either be a series of surface observations of data from a MOS report. More...

#include "../include/MeteoPlot.h"

Inheritance diagram for WXP::MeteoPlot:

Public Types
enum	Type { PLOT , DATA }
enum	{ SFC , MOS }

Public Member Functions
	MeteoPlot (const char *param)
int	init ()
int	setType (int rtype)
int	setType (const char *str)
int	getType ()
int	setParam (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 *name)
int	setFilename (Date &date)
int	setFilename (Date &date, const char *param)
int	setForeTime (const char *fore)
int	setModel (const char *str)
int	setIdent (const char *str)
int	setAttr (const char *str)
int	setGridAttr (const char *str)
int	setLabelAttr (const char *str)
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	getDomain (Domain &domain)
int	getSync ()
int	getSfcStation (const char *id, SfcData sdata[], int &num)
int	getMosStation (const char *id, SfcData sdata[], int &num)
int	getRange (SfcData data[], int num, VarSpec &spec, Range &range)
float	getX (float x)
float	getY (float y)
int	setPlotSize (VarSpec &spec, int type)
int	nextPlot ()
int	setPlot (VarSpec &spec, Range &range)
int	drawGrid (Plot &plot, const char *label)
int	drawData (Plot &plot, SfcData data[], int num, VarSpec &spec)
int	drawPlot (Plot &plot, SfcData data[], int num, VarSpec &spec)
int	draw (Plot &plot)
int	draw (Plot &plot, SfcData data[], int rnum)
void	callback (const char *ev_str, const char *ev_data, const void *data)
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 a time series meteogram. This can either be a series of surface observations of data from a MOS report.

Author

Dan Vietor

Member Function Documentation

callback()

void MeteoPlot::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 MeteoPlot::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::DateTool::createLabel(), draw(), and WXP::String::get().

Referenced by draw().

getDate()

int MeteoPlot::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

getDateOffset()

int MeteoPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

getDomain()

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

getInitDate()

int MeteoPlot::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

getLoopType()

int MeteoPlot::getLoopType ( )

virtual

Gets the available loop types

Returns

Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

getNumFrames()

int MeteoPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns

Number of frames

Implements WXP::Drawing.

getSync()

int WXP::MeteoPlot::getSync ( )

inlinevirtual

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

Returns

Number of frames

Implements WXP::Drawing.

init()

int MeteoPlot::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References WXP::StrLib::copy(), setFile(), setModel(), and setParam().

print()

int MeteoPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

setFile()

int MeteoPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References WXP::StrLib::copy(), setInput(), and setNameConv().

Referenced by init().

setFilename() [1/4]

int MeteoPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

setFilename() [2/4]

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

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

setIdent()

int MeteoPlot::setIdent

(

const char *

str

)

Sets the station identifier or location to be used.

Parameters

str	The model name

References WXP::StrLib::copy().

setInput()

int MeteoPlot::setInput ( const char * type )

virtual

A method for setting input file type

Parameters

name	Name convention to use

Implements WXP::Drawing.

References WXP::StrLib::equal().

Referenced by setFile().

setModel()

int MeteoPlot::setModel

(

const char *

str

)

Sets the model type to be used.

Parameters

str	The model name

References WXP::StrLib::copy(), and WXP::StrLib::valid().

Referenced by init().

setNameConv()

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

Referenced by init().

---

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

• MeteoPlot.h
• MeteoPlot.cc