WXP::LightPlot Class Reference

This class plots lightning data. More...

#include "../include/LightPlot.h"

Inheritance diagram for WXP::LightPlot:
WXP::Drawing WXP::Listener

List of all members.

Public Member Functions

 LightPlot (const char *param)
int init ()
int setParam (const char *str)
int setPath (const char *path)
int setFile ()
int setInput (const char *str)
int setNameConv (const char *name)
int setFilename ()
int setFilename (const char *name)
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 getDomain (Domain &domain)
int getSync ()
int setColor (const char *str)
int setColorFill (const char *str)
int draw (Plot &plot)
void callback (const char *ev_str, const char *ev_data, const void *data)
int print ()

Detailed Description

This class plots lightning data.

Author:
Dan Vietor

Member Function Documentation

void LightPlot::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 LightPlot::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::Plot::drawMark(), WXP::Plot::drawText(), WXP::StrLib::equal(), WXP::String::get(), WXP::Plot::getColorMap(), WXP::Filename::getDate(), WXP::Date::getHour(), WXP::Date::getMinute(), WXP::Filename::getName(), WXP::Filename::getNumFiles(), WXP::Date::getSecond(), WXP::Date::getSeconds(), WXP::Date::init(), WXP::Date::isSet(), WXP::Wxp::outMessage(), WXP::EarthPoint::set(), WXP::ColorFill::set(), WXP::Filename::setFile(), WXP::Plot::setMark(), WXP::Filename::setNumFiles(), WXP::Plot::setText(), WXP::DateRange::valid(), and WXP::String::valid().

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

Gets the offset time between frames in loop

Return values:
date Date information

Implements WXP::Drawing.

int LightPlot::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.

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

Gets the available loop types

Returns:
Loop type

Implements WXP::Drawing.

int LightPlot::getNumFrames (  )  [virtual]

Gets the possible number of frames in a loop

Returns:
Number of frames

Implements WXP::Drawing.

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

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

Returns:
Number of frames

Implements WXP::Drawing.

int LightPlot::print (  )  [virtual]

Method for printing class info

Implements WXP::Drawing.

int LightPlot::setColor ( const char *  str  ) 

Sets the color parameters

Parameters:
str Color string

References WXP::String::set().

int LightPlot::setFile (  )  [virtual]

A method for setting basic file parameters

Implements WXP::Drawing.

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

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

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

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

Sets specific forecast time to plot

Parameters:
fore Forecast time

Implements WXP::Drawing.

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

A method for setting input file type

Parameters:
name Name convention to use

Implements WXP::Drawing.

Referenced by setFile().

int LightPlot::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::getType(), WXP::Filename::setNameConv(), and WXP::StrLib::valid().

Referenced by setFile().

int LightPlot::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::getFloat(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::String::set(), and WXP::Strings::set().

int LightPlot::setPath ( const char *  path  ) 

Sets up the path to the data files

Parameters:
path The directory path

References WXP::Filename::setPath().

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