WXP::RedbookPlot Class Reference

This class plots redbook graphics files. More...

#include "../include/RedbookPlot.h"

Inheritance diagram for WXP::RedbookPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Member Functions

int init ()
int setParam (const char *str)
int setPath (const char *path)
int setFile ()
int setInput (const char *file)
int setNameConv (const char *file)
int setFilename ()
int setFilename (const char *file)
int setFilename (Date &date)
int setFilename (Date &date, const char *param)
int setForeTime (const char *fore)
int getDate (Date &date)
int getInitDate (Date &date)
int getDateOffset ()
int getLoopType ()
int getNumFrames ()
int setDomain (Domain &rdomain)
int getDomain (Domain &rdomain)
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 redbook graphics files.

Author:
Dan Vietor

Member Function Documentation

void RedbookPlot::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 RedbookPlot::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::Points::add(), WXP::Plot::addLabel(), WXP::FileTool::addPath(), WXP::File::close(), WXP::StrLib::copy(), WXP::DateTool::createLabel(), WXP::DomainTool::decode(), WXP::Plot::drawFill(), WXP::Plot::drawLine(), WXP::Plot::drawMark(), WXP::Plot::drawText(), WXP::StrLib::equal(), WXP::String::get(), WXP::Wxp::getDatabasePath(), WXP::Domain::getDy(), WXP::File::getLine(), WXP::Filename::getName(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Point::init(), WXP::Domain::isSet(), WXP::EarthPoint::lat, WXP::EarthPoint::lon, WXP::File::open(), WXP::Wxp::outDebug(), WXP::Wxp::outMessage(), WXP::Domain::print(), WXP::GridPoint::set(), WXP::Filename::setFile(), WXP::Plot::setFillColor(), WXP::Plot::setFillStyle(), WXP::Plot::setLine(), WXP::Plot::setText(), WXP::Domain::tran(), WXP::StrLib::valid(), WXP::Point::x, and WXP::Point::y.

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

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

int RedbookPlot::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::decode(), WXP::Filename::getName(), WXP::Domain::init(), WXP::Domain::isSet(), and WXP::Wxp::outMessage().

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

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int RedbookPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

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

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

Returns:
Number of frames

Implements WXP::Drawing.

int RedbookPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int RedbookPlot::setFile (  )  [virtual]

A method for setting basic file parameters

Implements WXP::Drawing.

References WXP::Filename::setNameConv().

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

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

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

Sets specific forecast time to plot

Parameters:
fore Forecast time

Implements WXP::Drawing.

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

A method for setting input file type

Parameters:
name Name convention to use

Implements WXP::Drawing.

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

int RedbookPlot::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::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), and WXP::Strings::iequal().

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