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

This class plots U and V gridpoint data. More...

#include "../include/GridVect.h"

Inheritance diagram for WXP::GridVect:
WXP::Drawing WXP::Listener

Public Member Functions

 GridVect (const char *param)
 
int init ()
 
int setParam (const char *str)
 
int setFile ()
 
int setInput (const char *type)
 
int setNameConv (const char *name)
 
int setFilename ()
 
int setFilename (const char *str)
 
int setFilename (Date &date)
 
int setFilename (Date &date, const char *param)
 
int setForeTime (const char *fore)
 
int getDomain (Domain &domain)
 
int getDate (Date &date)
 
int getInitDate (Date &date)
 
int getDateOffset ()
 
int getLoopType ()
 
int getNumFrames ()
 
int setModel (const char *str)
 
void callback (const char *ev_str, const char *ev_data, const void *data)
 
int setMap (bool val)
 
int setLabel (int val)
 
int setColorTable (const char *str)
 
int setColorFill (const char *str)
 
float getMax ()
 
int getSync ()
 
int draw (Plot &plot, Grid &grid1, Grid &grid2)
 
int draw (Plot &plot)
 
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 U and V gridpoint data.

Author
Dan Vietor

Member Function Documentation

◆ callback()

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

◆ draw()

int GridVect::draw ( Plot plot)
virtual

Method for plotting the actual data

Parameters
plotThe plot class specifying window and parameters for plotting

Implements WXP::Drawing.

References WXP::Wxp::checkMessage(), WXP::String::get(), WXP::Filename::getName(), WXP::GridSpec::init(), WXP::ModelSpec::init(), WXP::Wxp::outMessage(), WXP::Grid::print(), WXP::Filename::setFile(), and WXP::Filename::setName().

◆ getDate()

int GridVect::getDate ( Date date)
virtual

Gets the current date of the data in the file

Return values
dateDate information

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int GridVect::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getDomain()

int GridVect::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::FileTool::addOutPath(), WXP::String::get(), WXP::Grid::getDomain(), WXP::Filename::getName(), WXP::GridFile::isOpen(), WXP::FileAttr::READ, and WXP::Filename::setFile().

◆ getInitDate()

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

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int GridVect::getNumFrames ( )
virtual

Gets the possible number of frames in a loop

Returns
Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

◆ getSync()

int WXP::GridVect::getSync ( )
inlinevirtual

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

Returns
Number of frames

Implements WXP::Drawing.

◆ init()

int GridVect::init ( )
virtual

◆ print()

int GridVect::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColorFill()

int GridVect::setColorFill ( const char *  str)

Sets the color fill parameters

Parameters
strColor fill string

References WXP::VectPlot::setColorFill().

◆ setColorTable()

int GridVect::setColorTable ( const char *  str)

Sets the color table parameters

Parameters
strColor table parameter

References WXP::VectPlot::setColorTable().

Referenced by WXP::SfcPlot::setColorTable(), and WXP::UpaPlot::setColorTable().

◆ setFile()

int GridVect::setFile ( )
virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References WXP::ModelSpec::getName(), WXP::ModelSpec::set(), and setNameConv().

◆ setFilename() [1/4]

int GridVect::setFilename ( )
virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [2/4]

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

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setInput()

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

Sets the file input file type

Parameters
typeThe file type

Implements WXP::Drawing.

◆ setModel()

int GridVect::setModel ( const char *  str)

Sets the model type to be used.

Parameters
strThe model name

References WXP::StrLib::copy(), WXP::ModelSpec::getName(), WXP::ModelSpec::set(), and WXP::Filename::setNameConv().

◆ setNameConv()

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

Sets the file name convention

Parameters
nameThe optional name convention

Implements WXP::Drawing.

References WXP::ModelSpec::getName(), WXP::ModelSpec::set(), WXP::Filename::setNameConv(), and WXP::StrLib::valid().

Referenced by setFile().

◆ setParam()

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

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