WXP::UpaPlot Class Reference

This class plots surface data. More...

#include "../include/UpaPlot.h"

Inheritance diagram for WXP::UpaPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Member Functions

 UpaPlot (const char *param)
int init ()
int setParam (const char *str)
int setPath (const char *path)
int setFile ()
int setInput (const char *type)
int setNameConv (const char *name)
int setHour (const char *str)
int setFilename ()
int setFilename (const char *str)
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 setVariable (const char *str)
int setLevel (const char *str)
int setMap (bool val)
int getDate (Date &date)
int getInitDate (Date &date)
int getDateOffset ()
int getLoopType ()
int getNumFrames ()
int setPlot (Plot &plot)
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 ()

Detailed Description

This class plots surface data.

Author:
Dan Vietor

Member Function Documentation

void UpaPlot::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 UpaPlot::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::String::append(), WXP::String::clear(), WXP::UpaDataTool::compute(), WXP::UpaGrid::compute(), WXP::StrLib::copy(), WXP::MapPlot::draw(), WXP::String::get(), WXP::Filename::getName(), WXP::UpaDataTool::getUnits(), WXP::VarSpec::init(), WXP::GridSpec::init(), WXP::Wxp::isDebug(), WXP::Domain::isSet(), WXP::Wxp::outDebug(), WXP::Wxp::outWarning(), WXP::VarList::print(), WXP::FileAttr::READ, WXP::StrLib::replace(), WXP::VarSpec::set(), WXP::Level::set(), WXP::Filename::setFile(), WXP::Plot::setFill(), WXP::Grid::setInfo(), WXP::Plot::setLine(), WXP::Plot::setMark(), WXP::GridCont::setParam(), WXP::MapPlot::setParam(), WXP::Plot::setText(), WXP::UpaGrid::setVariable(), WXP::VarSpec::toInfoLabel(), WXP::GridMath::units(), WXP::StrLib::valid(), and WXP::String::valid().

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

Gets the date information from the input file

Return values:
date Date values

Implements WXP::Drawing.

References WXP::Filename::getDate().

int UpaPlot::getDateOffset (  )  [virtual]

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

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

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

Gets the initial date for a loop

Return values:
date Date information

Implements WXP::Drawing.

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

int UpaPlot::getLoopType (  )  [virtual]

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int UpaPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

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

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

Returns:
Number of frames

Implements WXP::Drawing.

int UpaPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int UpaPlot::setColor ( const char *  str  ) 

Sets the color parameters *

Parameters:
str Color string

References WXP::String::set().

Referenced by setParam().

int UpaPlot::setColorTable ( const char *  str  ) 

Sets the color table parameters *

Parameters:
str Color table parameter

References WXP::String::set().

Referenced by setParam().

int UpaPlot::setFile (  )  [virtual]

Sets the default file parameters

Implements WXP::Drawing.

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

int UpaPlot::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 UpaPlot::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 UpaPlot::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 UpaPlot::setFilename (  )  [virtual]

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

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

Sets specific forecast time to plot

Parameters:
fore Forecast time

Implements WXP::Drawing.

int UpaPlot::setInput ( const char *  str  )  [virtual]

Sets the input file type

Parameters:
str The file type

Implements WXP::Drawing.

Referenced by setFile().

int UpaPlot::setLevel ( const char *  str  ) 

Sets the level to be plotted *

Parameters:
str Level string

References WXP::String::set().

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

Sets the file name convention

Parameters:
name The name convention

Implements WXP::Drawing.

References WXP::Filename::setNameConv().

Referenced by setParam().

int UpaPlot::setParam ( const char *  str  )  [virtual]

Sets specific parameters for the plot given a string

Parameters:
str String specifying parameters

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::String::set(), setColor(), setColorTable(), setNameConv(), WXP::GridCont::setParam(), WXP::DatumPlot::setParam(), and setVariable().

int UpaPlot::setVariable ( const char *  str  ) 

Sets the variable to be plotted *

Parameters:
str Variable string

References WXP::String::set().

Referenced by setParam().

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