WXP C++ Library Version 6.74.9
Loading...
Searching...
No Matches
WXP::FrontPlot Class Reference

This class plots front data (ASUS01). More...

#include "../include/FrontPlot.h"

Inheritance diagram for WXP::FrontPlot:
WXP::Drawing WXP::Listener

Public Member Functions

 FrontPlot (const char *param)
int init ()
int setParam (const char *str)
int setFile ()
int setInput (const char *type)
int setNameConv (const char *type)
int setFilename ()
int setFilename (const char *str)
int setFilename (Date &date)
int setFilename (Date &date, const char *param)
int getDate (Date &date)
int getInitDate (Date &date)
int getDateOffset ()
int getLoopType ()
int setForeTime (const char *fore)
int getNumFrames ()
int getDomain (Domain &domain)
int setColor (const char *str)
int setMap (bool val)
int getSync ()
int draw (Plot &plot)
int draw (Plot &plot, FrontData &data)
int drawTriangle (Plot &plot, Point &pt1, Point &pt2, int dir)
int drawHalfCircle (Plot &plot, Point &pt1, Point &pt2, int dir)
void callback (const char *ev_str, const char *ev_data, const void *data)
int print ()

Additional Inherited Members

Static Public Attributes inherited from WXP::Drawing
static const int LOOP_NONE = 0
static const int LOOP_DATE = 1
static const int LOOP_FORE = 2

Detailed Description

This class plots front data (ASUS01).

Author
Dan Vietor

Member Function Documentation

◆ callback()

void FrontPlot::callback ( const char * ev_str,
const char * ev_data,
const void * data )
virtual

The event callback

Parameters
ev_strString containing description of event
ev_dataEvent specific data
dataUser specific data

Implements WXP::Listener.

◆ draw()

int FrontPlot::draw ( Plot & plot)
virtual

◆ getDate()

int FrontPlot::getDate ( Date & date)
virtual

Gets the current date of the data in the file

Return values
dateDate information

Implements WXP::Drawing.

◆ getDateOffset()

int FrontPlot::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getDomain()

int FrontPlot::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
domainDefault domain

Implements WXP::Drawing.

References WXP::DomainTool::decode().

◆ getInitDate()

int FrontPlot::getInitDate ( Date & date)
virtual

Gets the initial date for a loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getLoopType()

int FrontPlot::getLoopType ( )
virtual

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE, and WXP::Drawing::LOOP_FORE.

◆ getNumFrames()

int FrontPlot::getNumFrames ( )
virtual

Gets the possible number of frames in a loop

Returns
Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::FrontPlot::getSync ( )
inlinevirtual

Returns whether object is to be time sync

Implements WXP::Drawing.

◆ init()

int FrontPlot::init ( )
virtual

Initializes object

Implements WXP::Drawing.

References setFile(), setNameConv(), and setParam().

◆ print()

int FrontPlot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setFile()

int FrontPlot::setFile ( )
virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

Referenced by init().

◆ setFilename() [1/4]

int FrontPlot::setFilename ( )
virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

◆ setFilename() [2/4]

int FrontPlot::setFilename ( const char * file)
virtual

A method for setting the default file for plotting

Parameters
fileFilename to use

Implements WXP::Drawing.

◆ setFilename() [3/4]

int FrontPlot::setFilename ( Date & date)
virtual

Sets the filename to use based on a specific date

Parameters
dateDate to use

Implements WXP::Drawing.

◆ setFilename() [4/4]

int FrontPlot::setFilename ( Date & date,
const char * param )
virtual

Sets the filename to use based on a specific date and parameters

Parameters
dateDate to use
paramParameters to use for offset to date

Implements WXP::Drawing.

◆ setForeTime()

int FrontPlot::setForeTime ( const char * fore)
virtual

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setInput()

int FrontPlot::setInput ( const char * type)
virtual

A method for setting input file type

Parameters
nameName convention to use

Implements WXP::Drawing.

References WXP::StrLib::equal(), WXP::StrLib::length(), and setNameConv().

Referenced by setFile(), and setParam().

◆ setMap()

int WXP::FrontPlot::setMap ( bool val)
inline

Sets whether map is to be plotted

◆ setNameConv()

int FrontPlot::setNameConv ( const char * name)
virtual

A method for setting input file name convention

Parameters
nameName convention to use

Implements WXP::Drawing.

Referenced by init(), setFile(), setInput(), and setParam().

◆ setParam()

int FrontPlot::setParam ( const char * str)
virtual

Sets specific parameters for the plot given a string

Parameters
strString specifying parameters

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), setInput(), and setNameConv().

Referenced by init().


The documentation for this class was generated from the following files: