WXP::RcmPlot Class Reference

This class plots surface data. More...

#include "../include/RcmPlot.h"

Inheritance diagram for WXP::RcmPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Types

enum  Type { SITE, MOS, MOSG }

Public Member Functions

 RcmPlot (const char *str)
int init ()
int setParam (const char *str)
int setPath (const char *path)
int setFile ()
int setInput (const char *rtype)
int getType (const char *rtype)
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 setColorTable (const char *str)
int setColor (const char *str)
int setColorFill (const char *str)
int setVariable (const char *str)
int setMap (bool val)
int setId (const char *str)
int getDate (Date &date)
int getInitDate (Date &date)
int getDateOffset ()
int getLoopType ()
int getNumFrames ()
int getDomain (Domain &domain)
int getSync ()
int draw (Plot &plot, Grid &grid)
int draw (Plot &plot, Image &image)
int draw (Plot &plot)
const char * getUnits (const char *name)
int toImage (RcmData &rdata, Image &image)
int getData (RcmData &storm, VarSpec &spec, Datum &datum)
int drawData (Plot &plot, RcmData &rdata)
void callback (const char *ev_str, const char *ev_data, const void *data)
int print ()

Detailed Description

This class plots surface data.

Author:
Dan Vietor

Member Function Documentation

void RcmPlot::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.

int RcmPlot::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::DateTool::createLabel(), WXP::RcmFile::decode(), WXP::StrLib::equal(), WXP::CityHash::get(), WXP::String::get(), WXP::Filename::getDate(), WXP::CityHashData::getLat(), WXP::CityHashData::getLon(), WXP::Filename::getName(), WXP::Wxp::isDebug(), WXP::Wxp::outMessage(), WXP::Wxp::outWarning(), WXP::Grid::print(), WXP::Image::print(), WXP::ColorFile::read(), WXP::FileAttr::READ, WXP::Plot::setColorMap(), WXP::Grid::setDatim(), WXP::Filename::setFile(), WXP::StrLib::valid(), and WXP::String::valid().

int RcmPlot::getDate ( Date &  rdate  )  [virtual]

Gets the date information from the input file

Return values:
date Date values

Implements WXP::Drawing.

References WXP::Filename::getDate(), WXP::Date::getMinute(), WXP::Date::isSet(), and WXP::Date::setMinute().

Referenced by WXP::RadPlot::getDate(), and WXP::RadPlot::getInitDate().

int RcmPlot::getDateOffset (  )  [virtual]

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

Referenced by WXP::RadPlot::getDateOffset().

int RcmPlot::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::DomainVal::clat, WXP::DomainVal::clon, WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::CityData::getLat(), WXP::CityData::getLon(), WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::DomainVal::plat, WXP::DomainVal::plon, WXP::DomainVal::proj, WXP::Domain::PSTEREO, WXP::CityTool::search(), WXP::DomainTool::set(), and WXP::Domain::set().

Referenced by WXP::RadPlot::getDomain().

int RcmPlot::getInitDate ( Date &  date  )  [virtual]

Gets the initial date for a loop

Return values:
date Date information

Implements WXP::Drawing.

References WXP::Filename::getDate(), WXP::Date::getMinute(), WXP::Date::isSet(), WXP::Filename::setFile(), and WXP::Date::setMinute().

int RcmPlot::getLoopType (  )  [virtual]

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int RcmPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

Referenced by WXP::RadPlot::getNumFrames().

int WXP::RcmPlot::getSync (  )  [inline, virtual]

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

Returns:
Number of frames

Implements WXP::Drawing.

int RcmPlot::getType ( const char *  rtype  ) 

Sets the input file type

Parameters:
type The file type

References WXP::StrLib::equal().

Referenced by setNameConv().

int RcmPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int RcmPlot::setColor ( const char *  str  ) 

Sets the color parameters

Parameters:
str Color string

References WXP::String::set().

Referenced by WXP::RadPlot::setColor(), and setParam().

int RcmPlot::setColorFill ( const char *  str  ) 

Sets the color fill parameters

Parameters:
str Color string

References WXP::String::set().

Referenced by WXP::RadPlot::setColorFill(), and setParam().

int RcmPlot::setColorTable ( const char *  str  ) 

Sets the color table parameters

Parameters:
str Color table parameter

References WXP::String::set().

Referenced by WXP::RadPlot::setColorTable(), and setParam().

int RcmPlot::setFile (  )  [virtual]

Sets the file parameters

Implements WXP::Drawing.

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

int RcmPlot::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::Filename::setDate().

int RcmPlot::setFilename ( Date &  date  )  [virtual]

Sets the filename to use based on a specific date

Parameters:
date Date to use

Implements WXP::Drawing.

References WXP::Filename::setDate().

int RcmPlot::setFilename ( const char *  file  )  [virtual]

A method for setting the default file for plotting

Parameters:
file Filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

int RcmPlot::setFilename (  )  [virtual]

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

Referenced by WXP::RadPlot::setFilename(), and setParam().

int WXP::RcmPlot::setForeTime ( const char *  fore  )  [inline, virtual]

Sets specific forecast time to plot

Parameters:
fore Forecast time

Implements WXP::Drawing.

int RcmPlot::setInput ( const char *  rtype  )  [virtual]

Sets the input file type

Parameters:
type The file type

Implements WXP::Drawing.

References WXP::StrLib::equal().

Referenced by setFile(), WXP::RadPlot::setInput(), and setParam().

int RcmPlot::setNameConv ( const char *  name  )  [virtual]

Sets the file name convention

Parameters:
name The file name convention

Implements WXP::Drawing.

References getType(), WXP::Filename::getType(), WXP::Filename::setNameConv(), WXP::Filename::setNumFiles(), and WXP::StrLib::valid().

Referenced by setFile(), WXP::RadPlot::setNameConv(), and setParam().

int RcmPlot::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::getFloat(), WXP::Strings::getInt(), WXP::Strings::getLength(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::Const::MISS, WXP::Convert::NMtoKM(), WXP::Strings::scanf(), setColor(), setColorFill(), setColorTable(), setFilename(), setInput(), setNameConv(), WXP::ImagePlot::setParam(), WXP::GridCont::setParam(), and setVariable().

Referenced by WXP::RadPlot::setParam().

int RcmPlot::setVariable ( const char *  str  ) 

Sets the variable to be plotted

Parameters:
str Variable string

References WXP::String::set().

Referenced by setParam(), and WXP::RadPlot::setVariable().

The documentation for this class was generated from the following files:
Generated on 8 Jan 2010 for WXP C++ Library by  doxygen 1.6.1