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

This class plots redbook graphics files. More...

#include "../include/RedbookPlot.h"

Inheritance diagram for WXP::RedbookPlot:
WXP::Drawing WXP::Listener

Public Member Functions

 RedbookPlot ()
 
int init ()
 
int setParam (const char *str)
 
int setPath (const char *path)
 
int setFile ()
 
int setInput (const char *file)
 
int setNameConv (const char *file)
 
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 setDomain (const char *str)
 
int setDomain (Domain &rdomain)
 
int getDomain (Domain &rdomain)
 
int setColorTable (const char *str)
 
int setColor (const char *str)
 
int setTimezone (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 redbook graphics files.

Author
Dan Vietor

Constructor & Destructor Documentation

◆ RedbookPlot()

RedbookPlot::RedbookPlot ( )

Constructor. Initializes class

References init(), and setFile().

Member Function Documentation

◆ callback()

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

Sets the callback for processing data from display

Parameters
ev_strThe event type
ev_dataThe event data such as cursor location
dataThe user defined data attached to event

Implements WXP::Listener.

◆ draw()

int RedbookPlot::draw ( Plot plot)
virtual

◆ getDate()

int RedbookPlot::getDate ( Date date)
virtual

Gets the date information from the input file

Return values
dateThe file date

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int RedbookPlot::getDateOffset ( )
virtual

Gets the date offset from name convention for loops

Returns
The offset in seconds

Implements WXP::Drawing.

◆ getDomain()

int RedbookPlot::getDomain ( Domain rdomain)
virtual

◆ getInitDate()

int RedbookPlot::getInitDate ( Date date)
virtual

Gets the date of the initial file (in loops)

Parameters
dateThe file date

Implements WXP::Drawing.

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

◆ getLoopType()

int RedbookPlot::getLoopType ( )
virtual

Returns the default loop type

Returns
The loop type (date)

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int RedbookPlot::getNumFrames ( )
virtual

Gets the possible number of frames in a loop

Returns
Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::RedbookPlot::getSync ( )
inlinevirtual

Returns whether object is a time sync

Implements WXP::Drawing.

◆ init()

int RedbookPlot::init ( )
virtual

◆ print()

int RedbookPlot::print ( )
virtual

Prints class information

Implements WXP::Drawing.

◆ setColor()

int RedbookPlot::setColor ( const char *  str)

Sets the color parameters

Parameters
strColor string

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorTable()

int RedbookPlot::setColorTable ( const char *  str)

Sets the color table parameters

Parameters
strColor table parameter

References WXP::String::set().

Referenced by init(), and setParam().

◆ setDomain() [1/2]

int RedbookPlot::setDomain ( const char *  str)

Sets the domain for interpreting XY coordinates

Parameters
domainCoordinate domain

References WXP::DomainTool::decode().

Referenced by init().

◆ setDomain() [2/2]

int RedbookPlot::setDomain ( Domain rdomain)

Sets the domain for interpreting XY coordinates

Parameters
domainCoordinate domain

◆ setFile()

int RedbookPlot::setFile ( )
virtual

Sets up the file parameters

Implements WXP::Drawing.

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

Referenced by init(), and RedbookPlot().

◆ setFilename() [1/4]

int RedbookPlot::setFilename ( )
virtual

Sets the input file name

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [2/4]

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

Sets a specific file name

Parameters
strThe filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/4]

int RedbookPlot::setFilename ( Date date)
virtual

Sets the input file date. The file name is derived using name convention

Parameters
dateThe file date

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/4]

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

Sets the input file date with parameters. This is passed to the name convention to set file name

Parameters
dateThe file date
paramThe name convention parameters

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setForeTime()

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

Sets the forecast time (ignored)

Implements WXP::Drawing.

◆ setHour()

int RedbookPlot::setHour ( const char *  str)

Sets the specific file time

Parameters
strThe file time (hour)

References WXP::Filename::setFixDate().

Referenced by setFile().

◆ setInput()

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

Sets the input file type

Parameters
strThe file type

Implements WXP::Drawing.

Referenced by setFile().

◆ setMap()

int WXP::RedbookPlot::setMap ( bool  val)
inline

Sets whether object is to draw map or not

Referenced by setParam().

◆ setNameConv()

int RedbookPlot::setNameConv ( const char *  file)
virtual

Sets the file name convention

Parameters
nameThe name convention

Implements WXP::Drawing.

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

Referenced by init(), and setFile().

◆ setParam()

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

Sets the parameters within the class:

Parameters
strString to parse
ct=file - Color table file
co=color - Plotting color
fill=pat - Fill pattern for polygons proj=# - Sets projection flag (1,2) type=str - Type of plot, lookup in redbook.lup to find label map - Plots a map sync - Specifes object as time sync

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), setColor(), setColorTable(), and setMap().

Referenced by init().

◆ setPath()

int RedbookPlot::setPath ( const char *  path)

Sets the input file path

Parameters
pathThe file path

References WXP::Filename::setPath().

◆ setTimezone()

int RedbookPlot::setTimezone ( const char *  str)

Sets the timezone for dates

Parameters
strZone

References WXP::Timezone::set().

Referenced by init().


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