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

This class plots NIDS data. More...

#include "../include/NidsPlot.h"

Inheritance diagram for WXP::NidsPlot:
WXP::Drawing WXP::Listener

Public Member Functions

 NidsPlot ()
 
 NidsPlot (const char *str)
 
int init ()
 
int setParam (const char *str)
 
int setPath (const char *path)
 
int setFile ()
 
int setInput (const char *type)
 
int setNameConv (const char *type)
 
int setHour (const char *str)
 
int setFilename ()
 
int setFilename (Filename &rfile)
 
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 getDomain (Domain &domain)
 
int getInfo (NidsInfo &rinfo)
 
int setId (const char *str)
 
int setType (const char *str)
 
int setVariable (const char *str)
 
int setColorTable (const char *str)
 
int setColorFill (const char *str)
 
int setColor (const char *str)
 
int setMap (bool val)
 
int getSync ()
 
int drawImage (Plot &plot)
 
int drawData (Plot &plot)
 
const char * getUnits (const char *name)
 
int drawStorm (Plot &plot, StormAttr &storm)
 
int draw (Plot &plot)
 
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 NIDS data.

Author
Dan Vietor

Constructor & Destructor Documentation

◆ NidsPlot()

NidsPlot::NidsPlot ( )

Constructor. Initializes class data

References init().

Member Function Documentation

◆ callback()

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

◆ draw()

int NidsPlot::draw ( Plot plot)
virtual

◆ drawData()

int NidsPlot::drawData ( Plot plot)

◆ getDate()

int NidsPlot::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 NidsPlot::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

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

◆ getDomain()

int NidsPlot::getDomain ( Domain domain)
virtual

◆ getInitDate()

int NidsPlot::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 NidsPlot::getLoopType ( )
virtual

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int NidsPlot::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::NidsPlot::getSync ( )
inlinevirtual

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

Returns
Number of frames

Implements WXP::Drawing.

◆ init()

int NidsPlot::init ( )
virtual

◆ print()

int NidsPlot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

References WXP::String::get(), and WXP::Filename::getName().

◆ setColor()

int NidsPlot::setColor ( const char *  str)

Sets the color parameters for data plotting

Parameters
strColor string

References WXP::String::set().

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

◆ setColorFill()

int NidsPlot::setColorFill ( const char *  str)

Sets the color fill parameters

Parameters
strColor fill string

References WXP::String::set().

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

◆ setColorTable()

int NidsPlot::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 NidsPlot::setFile ( )
virtual

Sets the file parameters such as input file type

Implements WXP::Drawing.

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

Referenced by init().

◆ setFilename() [1/5]

int NidsPlot::setFilename ( )
virtual

Sets the filename to be used. Prompts the user for the filename

Implements WXP::Drawing.

References WXP::Filename::setFile().

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

◆ setFilename() [2/5]

int NidsPlot::setFilename ( const char *  str)
virtual

Sets the filename to be used.

Parameters
strThe filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/5]

int NidsPlot::setFilename ( Date date)
virtual

Sets the filename from a Date class.

Parameters
dateDate values to use in setting up filename

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/5]

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

Sets the filename from a date and parameters

Parameters
dateDate values to use in setting up filename
paramParameters to modify name generation

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [5/5]

int NidsPlot::setFilename ( Filename rfile)

Sets the filename to be used. Prompts the user for the filename

Parameters
rfileThe filename class

◆ setForeTime()

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

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setId()

int NidsPlot::setId ( const char *  str)

Sets the station ID

Parameters
strStation ID

References WXP::StrLib::copy().

Referenced by init().

◆ setInput()

int NidsPlot::setInput ( const char *  str)
virtual

Sets the input parameters

Parameters
strThe parameters

Implements WXP::Drawing.

Referenced by setFile().

◆ setNameConv()

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

Sets the file name convention

Parameters
typeThe optional name convention

Implements WXP::Drawing.

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

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

◆ setParam()

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

Sets basic parameters given a string of options

Parameters
strString containing parameters
ct=file - Color table file
cof=colors - Color fill colors for NIDS plot
va=var - Variable to plot
if=conv - Input file name convention
nc=conv - Input file name convention
tz=zone - Time zone
pa=path - Input file path
id=site - Radar site ID (goes to i)
ty=type - Radar data type (goes to t)
plot - Draw only plot
data - Draw only text data
site - Plot marker at site
dist=#:#:#:# - Plot distance rings (up to 4 in km)
distm=#:#:#:# - Plot distance rings (up to 4 in nm)
map - Have this object plot the map
nodist - Disable distance rings
table - Plot storm attribute table
notable - Don't plot storm attribute table
clutter - Set clutter radius to 25nm
clutter=# - Set clutter radius to #km
noclutter - Disable clutter radius
ramp:db:rng - Sets ramp echo elimination (max dbz and range)

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::Strings::getInt(), WXP::Strings::getLength(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::Convert::NMtoKM(), WXP::Strings::scanf(), WXP::Timezone::set(), setColorFill(), setColorTable(), setNameConv(), setPath(), and setVariable().

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

◆ setPath()

int NidsPlot::setPath ( const char *  path)

Sets up the path to the data files

Parameters
pathThe directory path

References WXP::Filename::setPath().

Referenced by setParam().

◆ setType()

int NidsPlot::setType ( const char *  str)

Sets the product type

Parameters
strProduct type

References WXP::StrLib::copy().

Referenced by init().

◆ setVariable()

int NidsPlot::setVariable ( const char *  str)

Sets the plot variables

Parameters
strVaraibles to plot

References WXP::String::set().

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


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