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

This class plots surface data. More...

#include "../include/RadPlot.h"

Inheritance diagram for WXP::RadPlot:
WXP::Drawing WXP::Listener

Public Types

enum  Type {
  UNK , MDR , MDRSITE , RCM ,
  RCMSITE , IMG , NIDS , LEV2 ,
  NOWRAD , KAVRAD , GRIB , GINIP
}

Public Member Functions

 RadPlot (const char *str)
int init ()
int setParam (const char *str)
int setPath (const char *path)
int setFile ()
int setInput (const char *rtype)
int getType (const char *rtype)
int setSubType (const char *str)
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 setColorTable (const char *str)
int setColor (const char *str)
int setColorFill (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, Image &image)
int draw (Plot &plot)
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 surface data.

Author
Dan Vietor

Member Function Documentation

◆ callback()

void RadPlot::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()

◆ getDate()

int RadPlot::getDate ( Date & date)
virtual

Gets the date information from the input file

Return values
dateDate values

Implements WXP::Drawing.

◆ getDateOffset()

int RadPlot::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getDomain()

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

◆ getInitDate()

int RadPlot::getInitDate ( Date & date)
virtual

Gets the initial date for a loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getLoopType()

int RadPlot::getLoopType ( )
virtual

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int RadPlot::getNumFrames ( )
virtual

Gets the possible number of frames in a loop

Returns
Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::RadPlot::getSync ( )
inlinevirtual

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

Returns
Number of frames

Implements WXP::Drawing.

◆ getType()

int RadPlot::getType ( const char * rtype)

Sets the input file type

Parameters
typeThe file type

References WXP::StrLib::equal().

Referenced by setNameConv().

◆ init()

◆ print()

int RadPlot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColor()

int RadPlot::setColor ( const char * str)

Sets the color parameters

Parameters
strColor string

◆ setColorFill()

int RadPlot::setColorFill ( const char * str)

Sets the color fill parameters

Parameters
strColor string

Referenced by init().

◆ setColorTable()

int RadPlot::setColorTable ( const char * str)

Sets the color table parameters

Parameters
strColor table parameter

References WXP::Image::set().

Referenced by init().

◆ setFile()

int RadPlot::setFile ( )
virtual

Sets the file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

Referenced by init().

◆ setFilename() [1/4]

int RadPlot::setFilename ( )
virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

Referenced by setParam().

◆ setFilename() [2/4]

int RadPlot::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 RadPlot::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 RadPlot::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 WXP::RadPlot::setForeTime ( const char * fore)
inlinevirtual

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setInput()

int RadPlot::setInput ( const char * rtype)
virtual

Sets the input file type

Parameters
typeThe file type

Implements WXP::Drawing.

References WXP::StrLib::equal().

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

◆ setNameConv()

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

Sets the file name convention

Parameters
nameThe file name convention

Implements WXP::Drawing.

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

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

◆ setParam()

int RadPlot::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::getNum(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), setFilename(), setInput(), and setNameConv().

Referenced by init().

◆ setSubType()

int RadPlot::setSubType ( const char * str)

Sets the product subtype

Parameters
strProduct type

References WXP::StrLib::copy().

Referenced by init().

◆ setVariable()

int RadPlot::setVariable ( const char * str)

Sets the variable to be plotted

Parameters
strVariable string

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