WXP::RadPlot Class Reference

This class plots surface data. More...

#include "../include/RadPlot.h"

Inheritance diagram for WXP::RadPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Types

enum  Type {
  UNK, MDR, MDRSITE, RCM,
  RCMSITE, IMG, NIDS, LEV2,
  NOWRAD, KAVRAD
}

Public Member Functions

 RadPlot (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 getDate (Date &date)
int getInitDate (Date &date)
int getDateOffset ()
int getLoopType ()
int getNumFrames ()
int getDomain (Domain &domain)
int getSync ()
int draw (Plot &plot, Image &image)
int draw (Plot &plot)
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 RadPlot::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 RadPlot::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::Lev2Plot::draw(), WXP::NidsPlot::draw(), WXP::Filename::getName(), WXP::KavradFile::isOpen(), WXP::NowradFile::isOpen(), WXP::KavradFile::open(), WXP::NowradFile::open(), WXP::ImageFile::open(), WXP::Wxp::outWarning(), WXP::KavradFile::read(), WXP::NowradFile::read(), WXP::ImageFile::read(), WXP::FileAttr::READ, and WXP::Filename::setFile().

int RadPlot::getDate ( Date &  date  )  [virtual]

Gets the date information from the input file

Return values:
date Date values

Implements WXP::Drawing.

References WXP::Filename::getDate(), WXP::Lev2Plot::getDate(), WXP::NidsPlot::getDate(), WXP::RcmPlot::getDate(), and WXP::MdrPlot::getDate().

int RadPlot::getDateOffset (  )  [virtual]

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

References WXP::Lev2Plot::getDateOffset(), WXP::NidsPlot::getDateOffset(), WXP::RcmPlot::getDateOffset(), and WXP::MdrPlot::getDateOffset().

int RadPlot::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::RcmPlot::getDomain(), WXP::MdrPlot::getDomain(), WXP::NidsPlot::getDomain(), and WXP::DomainTool::set().

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

Gets the initial date for a loop

Return values:
date Date information

Implements WXP::Drawing.

References WXP::Filename::getDate(), WXP::Lev2Plot::getDate(), WXP::NidsPlot::getDate(), WXP::RcmPlot::getDate(), WXP::MdrPlot::getDate(), and WXP::Filename::setFile().

int RadPlot::getLoopType (  )  [virtual]

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int RadPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles(), WXP::Lev2Plot::getNumFrames(), WXP::NidsPlot::getNumFrames(), WXP::RcmPlot::getNumFrames(), and WXP::MdrPlot::getNumFrames().

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

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

Returns:
Number of frames

Implements WXP::Drawing.

int RadPlot::getType ( const char *  rtype  ) 

Sets the input file type

Parameters:
type The file type

References WXP::StrLib::equal().

Referenced by setNameConv().

int RadPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int RadPlot::setColor ( const char *  str  ) 

Sets the color parameters

Parameters:
str Color string

References WXP::NidsPlot::setColor(), WXP::RcmPlot::setColor(), and WXP::MdrPlot::setColor().

int RadPlot::setColorFill ( const char *  str  ) 

Sets the color fill parameters

Parameters:
str Color string

References WXP::String::set(), WXP::ImagePlot::setColorFill(), WXP::Lev2Plot::setColorFill(), WXP::NidsPlot::setColorFill(), WXP::RcmPlot::setColorFill(), and WXP::MdrPlot::setColorFill().

int RadPlot::setColorTable ( const char *  str  ) 

Sets the color table parameters

Parameters:
str Color table parameter

References WXP::String::set(), WXP::ImagePlot::setColorTable(), WXP::Lev2Plot::setColorTable(), WXP::NidsPlot::setColorTable(), WXP::RcmPlot::setColorTable(), and WXP::MdrPlot::setColorTable().

int RadPlot::setFile (  )  [virtual]

Sets the file parameters

Implements WXP::Drawing.

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

int RadPlot::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(), WXP::NidsPlot::setFilename(), WXP::RcmPlot::setFilename(), and WXP::MdrPlot::setFilename().

int RadPlot::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(), WXP::Lev2Plot::setFilename(), WXP::NidsPlot::setFilename(), WXP::RcmPlot::setFilename(), and WXP::MdrPlot::setFilename().

int RadPlot::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(), WXP::Lev2Plot::setFilename(), WXP::NidsPlot::setFilename(), WXP::RcmPlot::setFilename(), and WXP::MdrPlot::setFilename().

int RadPlot::setFilename (  )  [virtual]

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Lev2Plot::setFilename(), WXP::NidsPlot::setFilename(), WXP::RcmPlot::setFilename(), WXP::MdrPlot::setFilename(), and WXP::Filename::setFilePrompt().

Referenced by setParam().

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

Sets specific forecast time to plot

Parameters:
fore Forecast time

Implements WXP::Drawing.

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

Sets the input file type

Parameters:
type The file type

Implements WXP::Drawing.

References WXP::StrLib::equal(), WXP::RcmPlot::setInput(), WXP::MdrPlot::setInput(), WXP::Lev2Plot::setNameConv(), and WXP::NidsPlot::setNameConv().

Referenced by setFile(), and setParam().

int RadPlot::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::Lev2Plot::setNameConv(), WXP::NidsPlot::setNameConv(), WXP::RcmPlot::setNameConv(), WXP::MdrPlot::setNameConv(), WXP::Filename::setNameConv(), WXP::Filename::setNumFiles(), and WXP::StrLib::valid().

Referenced by setFile(), and setParam().

int RadPlot::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(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::String::set(), setFilename(), setInput(), setNameConv(), WXP::Lev2Plot::setParam(), WXP::NidsPlot::setParam(), WXP::ImagePlot::setParam(), WXP::RcmPlot::setParam(), and WXP::MdrPlot::setParam().

int RadPlot::setVariable ( const char *  str  ) 

Sets the variable to be plotted

Parameters:
str Variable string

References WXP::NidsPlot::setVariable(), WXP::RcmPlot::setVariable(), and WXP::MdrPlot::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