WXP::RawPlot Class Reference

This class plots raw data from file. More...

#include "../include/RawPlot.h"

Inheritance diagram for WXP::RawPlot:

Public Member Functions
	RawPlot (const char *param)
int	init ()
int	setParam (const char *str)
int	setPath (const char *path)
int	setFile ()
int	setNameConv (const char *type)
int	setHour (const char *str)
int	setInput (const char *str)
int	setFilename ()
int	setFilename (const char *file)
int	setFilename (Date &date)
int	setFilename (Date &date, const char *param)
int	setForeTime (const char *fore)
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	setColor (const char *str)
int	setVariable (const char *str)
int	setPlotType (const char *type)
int	setTimezone (const char *zone)
int	draw (Plot &plot)
int	draw (Plot &plot, const char *filename, const char *field, const char *param)
int	draw (Plot &plot, const char *filename)
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 raw data from file.

Author

Dan Vietor

Member Function Documentation

callback()

void RawPlot::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 RawPlot::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::FileTool::addOutPath(), WXP::StrLib::append(), WXP::ContPlot::BOTH, WXP::StrLib::copy(), WXP::DateTool::createLabel(), WXP::ContPlot::decodeType(), WXP::MapPlot::draw(), WXP::StrLib::equal(), WXP::ContPlot::FILL, WXP::String::get(), WXP::Datum::getData(), WXP::Datum::getLoc(), WXP::Wxp::isDebug(), WXP::ContPlot::LINE, WXP::Const::MISS, WXP::Wxp::outMessage(), WXP::MapPlot::setFillCont(), WXP::MapPlot::setParam(), and WXP::ContPlot::VALUE.

getDate()

int RawPlot::getDate ( Date & date )

virtual

Gets the date information from the input file

Return values

date	Date values

Implements WXP::Drawing.

getDateOffset()

int RawPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

getDomain()

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

getInitDate()

int RawPlot::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

getLoopType()

int RawPlot::getLoopType ( )

virtual

Gets the available loop types

Returns

Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

getNumFrames()

int RawPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns

Number of frames

Implements WXP::Drawing.

getSync()

int WXP::RawPlot::getSync ( )

inlinevirtual

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

Returns

Number of frames

Implements WXP::Drawing.

init()

int RawPlot::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References WXP::Const::MISS, setFile(), setNameConv(), and setParam().

print()

int RawPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

setFile()

int RawPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

Referenced by init().

setFilename() [1/4]

int RawPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

setFilename() [2/4]

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

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

setInput()

int RawPlot::setInput ( const char * type )

virtual

Sets the input file type

Parameters

type	The optional file name convention

Implements WXP::Drawing.

Referenced by setFile().

setNameConv()

int RawPlot::setNameConv ( const char * type )

virtual

Sets the file name convention

Parameters

type	The optional file name convention

Implements WXP::Drawing.

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

setParam()

int RawPlot::setParam ( const char * str )

virtual

Sets the plotting parameters

Parameters

str

Parameter string nc=name - Name convention on input file if=name - Name convention on input file va=var - Variable to extract from raw file tz=zone - Timezone to use in labels pl=type - Plot type (data, cf, lcf, etc) max=val - Plots only values less than val min=val - Plots only values greater than val sync - Sets object as time sync

See also

RawGrid::setParam DatumPlot::setParam GridCont::setParam

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), and setNameConv().

Referenced by init().

---

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

• RawPlot.h
• RawPlot.cc