WXP C++ Library Version 6.74.6
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
WXP::MdrPlot Class Reference

This class plots MDR radar data. More...

#include "../include/MdrPlot.h"

Inheritance diagram for WXP::MdrPlot:
WXP::Drawing WXP::Listener

Public Types

enum  Type { SITE , MOS , MOSG }
 

Public Member Functions

 MdrPlot (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 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 setId (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, Grid &grid)
 
int draw (Plot &plot, Image &image)
 
int draw (Plot &plot)
 
int toImage (MdrData &rdata, Image &image)
 
int drawData (Plot &plot, MdrData &rdata)
 
void callback (const char *ev_str, const char *ev_data, const void *data)
 
int print ()
 
virtual int init ()=0
 
virtual int getDomain (Domain &domain)=0
 
virtual int setFile ()=0
 
virtual int setInput (const char *type)=0
 
virtual int setNameConv (const char *name)=0
 
virtual int setFilename ()=0
 
virtual int setFilename (const char *file)=0
 
virtual int setFilename (Date &date)=0
 
virtual int setFilename (Date &date, const char *param)=0
 
virtual int setForeTime (const char *fore)=0
 
virtual int setParam (const char *str)=0
 
virtual int getDate (Date &date)=0
 
virtual int getLoopType ()=0
 
virtual int getInitDate (Date &date)=0
 
virtual int getDateOffset ()=0
 
virtual int getNumFrames ()=0
 
virtual int getSync ()=0
 
virtual int draw (Plot &plot)=0
 
virtual int print ()=0
 
virtual void callback (const char *ev_str, const char *ev_data, const void *data)=0
 

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 MDR radar data.

Author
Dan Vietor

Member Function Documentation

◆ callback()

void MdrPlot::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 MdrPlot::draw ( Plot plot)
virtual

◆ getDate()

int MdrPlot::getDate ( Date date)
virtual

Gets the date information from the input file

Return values
dateDate values

Implements WXP::Drawing.

References WXP::Filename::getDate().

Referenced by WXP::RadPlot::getDate(), and WXP::RadPlot::getInitDate().

◆ getDateOffset()

int MdrPlot::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

Referenced by WXP::RadPlot::getDateOffset().

◆ getDomain()

int MdrPlot::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::DomainVal::clat, WXP::DomainVal::clon, WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::CityData::getLat(), WXP::CityData::getLon(), WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::DomainVal::plat, WXP::DomainVal::plon, WXP::DomainVal::proj, WXP::Domain::PSTEREO, WXP::CityTool::search(), WXP::DomainTool::set(), and WXP::Domain::set().

Referenced by WXP::RadPlot::getDomain().

◆ getInitDate()

int MdrPlot::getInitDate ( Date date)
virtual

Gets the initial date for a loop

Return values
dateDate information

Implements WXP::Drawing.

References WXP::Filename::getDate(), and WXP::Filename::setFile().

◆ getLoopType()

int MdrPlot::getLoopType ( )
virtual

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int MdrPlot::getNumFrames ( )
virtual

Gets the possible number of frames in a loop

Returns
Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

Referenced by WXP::RadPlot::getNumFrames().

◆ getSync()

int WXP::MdrPlot::getSync ( )
inlinevirtual

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

Returns
Number of frames

Implements WXP::Drawing.

◆ getType()

int MdrPlot::getType ( const char *  rtype)

Sets the input file type

Parameters
typeThe file type

References WXP::StrLib::equal().

Referenced by setNameConv().

◆ init()

int MdrPlot::init ( )
virtual

◆ print()

int MdrPlot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColor()

int MdrPlot::setColor ( const char *  str)

Sets the color parameters

Parameters
strColor string

References WXP::String::set().

Referenced by WXP::RadPlot::setColor(), and setParam().

◆ setColorFill()

int MdrPlot::setColorFill ( const char *  str)

Sets the color fill parameters

Parameters
strColor string

References WXP::String::set().

Referenced by WXP::RadPlot::setColorFill(), and setParam().

◆ setColorTable()

int MdrPlot::setColorTable ( const char *  str)

Sets the color table parameters

Parameters
strColor table parameter

References WXP::String::set().

Referenced by WXP::RadPlot::setColorTable(), and setParam().

◆ setFile()

int MdrPlot::setFile ( )
virtual

Sets the file parameters

Implements WXP::Drawing.

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

Referenced by init().

◆ setFilename() [1/4]

int MdrPlot::setFilename ( )
virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFile().

Referenced by WXP::RadPlot::setFilename(), and setParam().

◆ setFilename() [2/4]

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

A method for setting the default file for plotting

Parameters
fileFilename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/4]

int MdrPlot::setFilename ( Date date)
virtual

Sets the filename to use based on a specific date

Parameters
dateDate to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/4]

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

References WXP::Filename::setFile().

◆ setForeTime()

int WXP::MdrPlot::setForeTime ( const char *  fore)
inlinevirtual

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setInput()

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

Sets the input file type

Parameters
typeThe file type

Implements WXP::Drawing.

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

Referenced by init(), setFile(), WXP::RadPlot::setInput(), and setParam().

◆ setNameConv()

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

Sets the file name convention

Parameters
nameThe file name convention

Implements WXP::Drawing.

References WXP::Filename::getType(), getType(), WXP::Filename::setNameConv(), WXP::Filename::setNumFiles(), and WXP::StrLib::valid().

Referenced by init(), setFile(), WXP::RadPlot::setNameConv(), and setParam().

◆ setParam()

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

◆ setVariable()

int MdrPlot::setVariable ( const char *  str)

Sets the variable to be plotted

Parameters
strVariable string

References WXP::String::set().

Referenced by init(), setParam(), and WXP::RadPlot::setVariable().


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