WXP::MeteoPlot Class Reference

This class plots a thermodynamic diagram. More...

#include "../include/MeteoPlot.h"

Inheritance diagram for WXP::MeteoPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Types

enum  Type { PLOT, DATA }
enum  { SFC, MOS }

Public Member Functions

 MeteoPlot (const char *param)
int init ()
int setType (int rtype)
int setType (const char *str)
int getType ()
int setParam (const char *str)
int setFile ()
int setInput (const char *type)
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 setModel (const char *str)
int promptId ()
int getDate (Date &date)
int getInitDate (Date &date)
int getDateOffset ()
int getLoopType ()
int getNumFrames ()
int getDomain (Domain &domain)
int getSync ()
int getSfcStation (const char *id, SfcData sdata[], int num)
int getMosStation (const char *id, SfcData sdata[], int num)
int getRange (SfcData data[], int num, VarSpec &spec, Range &range)
float getX (float x)
float getY (float y)
int setPlotSize (VarSpec &spec, int type)
int nextPlot ()
int setPlot (VarSpec &spec, Range &range)
int drawGrid (Plot &plot, const char *label)
int drawData (Plot &plot, SfcData data[], int num, VarSpec &spec)
int drawPlot (Plot &plot, SfcData data[], int num, VarSpec &spec)
int draw (Plot &plot)
int draw (Plot &plot, SfcData data[], int rnum)
void callback (const char *ev_str, const char *ev_data, const void *data)
int print ()

Detailed Description

This class plots a thermodynamic diagram.

Author:
Dan Vietor

Member Function Documentation

void MeteoPlot::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 MeteoPlot::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::DateTool::createLabel(), WXP::String::get(), and WXP::Filename::getDate().

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

Gets the current date of the data in the file

Return values:
date Date information

Implements WXP::Drawing.

References WXP::Filename::getDate().

int MeteoPlot::getDateOffset (  )  [virtual]

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

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

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

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int MeteoPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

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

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

Returns:
Number of frames

Implements WXP::Drawing.

int MeteoPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int MeteoPlot::setFile (  )  [virtual]

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

int MeteoPlot::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::getName(), WXP::Wxp::outMessage(), and WXP::Filename::setDate().

int MeteoPlot::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::getName(), WXP::Wxp::outMessage(), and WXP::Filename::setDate().

int MeteoPlot::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::getName(), WXP::Wxp::outMessage(), and WXP::Filename::setFile().

int MeteoPlot::setFilename (  )  [virtual]

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

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

Sets specific forecast time to plot

Parameters:
fore Forecast time

Implements WXP::Drawing.

int MeteoPlot::setInput ( const char *  type  )  [virtual]

A method for setting input file type

Parameters:
name Name convention to use

Implements WXP::Drawing.

References WXP::StrLib::equal().

Referenced by setFile().

int MeteoPlot::setModel ( const char *  str  ) 

Sets the model type to be used.

Parameters:
str The model name

References WXP::StrLib::copy(), and WXP::StrLib::valid().

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

A method for setting input file name convention

Parameters:
name Name convention to use

Implements WXP::Drawing.

References WXP::Filename::setNameConv().

Referenced by setFile().

int MeteoPlot::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(), and WXP::Strings::getString().

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