WXP::MosPlot Class Reference
[Plotting objects]

This class plots surface data. More...

#include "../include/MosPlot.h"

Inheritance diagram for WXP::MosPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Member Functions

 MosPlot (const char *param)
int init ()
int setParam (const char *str)
int setPath (const char *path)
int setFile ()
int setInput (const char *str)
int setModel (const char *str)
int setNameConv (const char *name)
int setHour (const char *str)
int setForeTime (const char *fore)
int setFilename ()
int setFilename (Date &date)
int setFilename (const char *str)
int setFilename (Date &date, const char *param)
int setColorTable (const char *str)
int setColor (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)
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 MosPlot::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 MosPlot::draw ( Plot &  plot  )  [virtual]

Plots the surface data

Parameters:
plot The plot object to draw to

Implements WXP::Drawing.

References WXP::Plot::addLabel(), WXP::String::append(), WXP::String::clear(), WXP::MosDataTool::compute(), WXP::MosGrid::compute(), WXP::StrLib::copy(), WXP::MapPlot::draw(), WXP::String::get(), WXP::MosFile::getDate(), WXP::Filename::getName(), WXP::MosDataTool::getUnits(), WXP::VarSpec::init(), WXP::GridSpec::init(), WXP::Wxp::isDebug(), WXP::Domain::isSet(), WXP::MosFile::open(), WXP::Wxp::outDebug(), WXP::Wxp::outMessage(), WXP::VarList::print(), WXP::MosFile::read(), WXP::StrLib::replace(), WXP::MosFile::rewind(), WXP::VarSpec::set(), WXP::Filename::setFile(), WXP::Plot::setFill(), WXP::Grid::setInfo(), WXP::Plot::setLine(), WXP::Plot::setMark(), WXP::MosFile::setModel(), WXP::GridCont::setParam(), WXP::MapPlot::setParam(), WXP::Plot::setText(), WXP::MosGrid::setVariable(), WXP::VarSpec::toInfoLabel(), WXP::GridMath::units(), WXP::StrLib::valid(), and WXP::String::valid().

int MosPlot::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 MosPlot::getDateOffset (  )  [virtual]

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

int MosPlot::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 MosPlot::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 MosPlot::getLoopType (  )  [virtual]

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int MosPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

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

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

Returns:
Number of frames

Implements WXP::Drawing.

int MosPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int MosPlot::setColor ( const char *  str  ) 

Sets the color parameters

Parameters:
str Color string

References WXP::String::set().

Referenced by setParam().

int MosPlot::setColorTable ( const char *  str  ) 

Sets the color table parameters

Parameters:
str Color table parameter

References WXP::String::set().

Referenced by setParam().

int MosPlot::setFile (  )  [virtual]

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

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

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

int MosPlot::setForeTime ( const char *  str  )  [virtual]

Sets the forecast time to be used.

Parameters:
str The forecast time

Implements WXP::Drawing.

References WXP::String::set().

Referenced by setParam().

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

Sets the input file type

Parameters:
str The file type

Implements WXP::Drawing.

Referenced by setFile().

int MosPlot::setModel ( const char *  str  ) 

Sets the model type to be used.

Parameters:
str The model name

References WXP::StrLib::copy().

Referenced by setParam().

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

Sets the file name convention

Parameters:
name The name convention

Implements WXP::Drawing.

References WXP::Filename::setNameConv().

Referenced by setFile().

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

Sets the parameters within the class:

Parameters:
str String to parse
ct=file - Color table file
cof=colors - Color fill colors for NIDS plot
va=var - Variable to plot
ho=hour - Fix date parameters (ie hour of day)
tz=zone - Zone information for label
sc=scale - Plot scale factor
loc_pr=prior - Priority of stations with location but no prior
pr=prior - Priority of stations to plot

Implements WXP::Drawing.

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

int MosPlot::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