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

This class plots NIDS data. More...

#include "../include/Lev2Plot.h"

Inheritance diagram for WXP::Lev2Plot:
WXP::Drawing WXP::Listener

Public Types

enum  Type { RAW , COMP }
 

Public Member Functions

 Lev2Plot ()
 
 Lev2Plot (const char *str)
 
int init ()
 
int setParam (const char *str)
 
int setFile ()
 
int setInput (const char *type)
 
int setId (const char *str)
 
int setNameConv (const char *name)
 
int setHour (const char *str)
 
int setFilename ()
 
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 (EarthPoint ept, Domain &domain)
 
int getDomain (Domain &domain)
 
int setVariable (const char *variable)
 
int setColorTable (const char *str)
 
int setColorFill (const char *str)
 
int setMap (bool val)
 
int getSync ()
 
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

◆ Lev2Plot()

Lev2Plot::Lev2Plot ( )

Constructor. Initializes class data

References init().

Member Function Documentation

◆ callback()

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

Event callback

Implements WXP::Listener.

◆ draw()

int Lev2Plot::draw ( Plot plot)
virtual

◆ getDate()

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

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

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

◆ getDomain()

int Lev2Plot::getDomain ( Domain domain)
virtual

◆ getInitDate()

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

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

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

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

Returns
Number of frames

Implements WXP::Drawing.

◆ init()

int Lev2Plot::init ( )
virtual

Initializes object

Implements WXP::Drawing.

References WXP::Lev2File::REF, setFile(), setId(), setNameConv(), and setParam().

Referenced by Lev2Plot().

◆ print()

int Lev2Plot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColorFill()

int Lev2Plot::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 Lev2Plot::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 Lev2Plot::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/4]

int Lev2Plot::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(), and setParam().

◆ setFilename() [2/4]

int Lev2Plot::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/4]

int Lev2Plot::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/4]

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

Sets the filename from a Date class.

Parameters
dateDate values to use in setting up filename

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setForeTime()

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

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setId()

int Lev2Plot::setId ( const char *  str)

Sets the station ID

Parameters
strStation ID

References WXP::StrLib::copy().

Referenced by init(), and setParam().

◆ setInput()

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

Sets the input file type

Parameters
typeThe file type

Implements WXP::Drawing.

References WXP::StrLib::equal().

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

◆ setNameConv()

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

Sets the file name convention

Parameters
nameThe name convention

Implements WXP::Drawing.

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

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

◆ setParam()

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

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