WXP C++ Library Version 6.74.9
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
WXP::MapPlot Class Reference

This class plots a set of maps. More...

#include "../include/MapPlot.h"

Inheritance diagram for WXP::MapPlot:
WXP::Drawing

Public Member Functions

 MapPlot ()
 
 MapPlot (const char *param)
 
 ~MapPlot ()
 
int init ()
 
int getDomain (Domain &domain)
 
int setMapFiles (const char *str)
 
int setFile ()
 
int setInput (const char *str)
 
int setNameConv (const char *name)
 
int setFilename ()
 
int setFilename (const char *name)
 
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 setFillCont (bool v)
 
int setColorTable (const char *str)
 
int setColor (const char *name)
 
int setColorLatLon (const char *name)
 
int setColorLine (const char *str)
 
int setParam (const char *str)
 
int getSync ()
 
int drawSegment (Plot &plot, Points &pts)
 
int draw (Plot &plot, const char *file)
 
int drawLatLon (Plot &plot, float dlat, float dlon)
 
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
 

Static Public Attributes

static const int UNDER = 1
 
static const int OVER = 2
 
- 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 a set of maps.

Author
Dan Vietor

Constructor & Destructor Documentation

◆ MapPlot() [1/2]

MapPlot::MapPlot ( )

Constructor

References init().

◆ MapPlot() [2/2]

MapPlot::MapPlot ( const char *  param)

Constructor. Sets parameters

Parameters
paramThe parameters

References init(), and setParam().

◆ ~MapPlot()

MapPlot::~MapPlot ( )

Destructor

Member Function Documentation

◆ draw() [1/2]

int MapPlot::draw ( Plot plot)
virtual

◆ draw() [2/2]

int MapPlot::draw ( Plot plot,
const char *  file 
)

◆ drawLatLon()

int MapPlot::drawLatLon ( Plot plot,
float  dlat,
float  dlon 
)

◆ drawSegment()

int MapPlot::drawSegment ( Plot plot,
Points pts 
)

Draws an individual map segment

Parameters
plotThe plot object
ptsThe points to plot

References WXP::Points::clear(), WXP::Plot::drawFill(), and WXP::Plot::drawLine().

Referenced by draw().

◆ getDate()

int MapPlot::getDate ( Date date)
virtual

Gets the file date (unused)

Return values
dateThe file date

Implements WXP::Drawing.

◆ getDateOffset()

int MapPlot::getDateOffset ( )
virtual

Returns the date offset (unused)

Implements WXP::Drawing.

◆ getDomain()

int MapPlot::getDomain ( Domain domain)
virtual

Gets the default domain

Parameters
domainThe domain

Implements WXP::Drawing.

References WXP::DomainTool::decode().

◆ getInitDate()

int MapPlot::getInitDate ( Date date)
virtual

Gets the initial date (unused)

Return values
dateThe date

Implements WXP::Drawing.

References WXP::Date::init().

◆ getLoopType()

int MapPlot::getLoopType ( )
virtual

Returns the loop type (none)

Implements WXP::Drawing.

References WXP::Drawing::LOOP_NONE.

◆ getNumFrames()

int MapPlot::getNumFrames ( )
virtual

Gets the number of frames (unused)

Implements WXP::Drawing.

◆ getSync()

int WXP::MapPlot::getSync ( )
inlinevirtual

Returns whether object is time sync (unused)

Implements WXP::Drawing.

◆ init()

int MapPlot::init ( )
virtual

Initializes the object

Implements WXP::Drawing.

References WXP::String::init(), WXP::Const::MISS, setColor(), setColorLatLon(), setColorTable(), and setParam().

Referenced by MapPlot(), and MapPlot().

◆ print()

int MapPlot::print ( )
virtual

Prints the object parameters

Implements WXP::Drawing.

◆ setColor()

int MapPlot::setColor ( const char *  str)

Sets the map color

Parameters
strThe map color

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorLatLon()

int MapPlot::setColorLatLon ( const char *  str)

Sets the lat/lon line color

Parameters
strThe color

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorLine()

int MapPlot::setColorLine ( const char *  str)

Sets the line color in filled polygons

Parameters
strThe color

References WXP::String::set().

Referenced by setParam().

◆ setColorTable()

int MapPlot::setColorTable ( const char *  str)

Sets the color table

Parameters
strThe color table file

References WXP::String::set().

Referenced by init(), and setParam().

◆ setFile()

int MapPlot::setFile ( )
virtual

Sets the file name (unused)

Implements WXP::Drawing.

◆ setFilename() [1/4]

int MapPlot::setFilename ( )
virtual

Sets the file name (unused)

Implements WXP::Drawing.

◆ setFilename() [2/4]

int MapPlot::setFilename ( const char *  name)
virtual

Sets the file name (unused)

Parameters
nameThe file name

Implements WXP::Drawing.

References setMapFiles().

◆ setFilename() [3/4]

int MapPlot::setFilename ( Date date)
virtual

Sets the file name (unused)

Parameters
dateThe file date

Implements WXP::Drawing.

◆ setFilename() [4/4]

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

Sets the file name (unused)

Parameters
dateThe date
paramThe parameters

Implements WXP::Drawing.

◆ setFillCont()

int WXP::MapPlot::setFillCont ( bool  v)
inline

Sets whether map object is to plot as fill overlay

Referenced by WXP::GridPlot::draw(), WXP::MosPlot::draw(), WXP::RawPlot::draw(), WXP::SfcPlot::draw(), and WXP::UpaPlot::draw().

◆ setForeTime()

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

Sets forecast time (ignored)

Implements WXP::Drawing.

◆ setInput()

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

A method for setting input file type

Parameters
nameName convention to use

Implements WXP::Drawing.

◆ setMapFiles()

int MapPlot::setMapFiles ( const char *  str)

Sets the list of map files to use

Parameters
strThe map list

References WXP::String::set().

Referenced by setFilename(), and setParam().

◆ setNameConv()

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

Sets the file name (unused)

Parameters
nameName convention

Implements WXP::Drawing.

◆ setParam()

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

Sets the object parameters

Parameters
strThe parameters ct=file - Color table file
co=color - Map Color
coll=color - Lat/lon line Color
coln=color - Color of lines in fill polygons
mf=maps - map list
map_in - disables map range check, all segment in domain
fill - fill map segments
fill_cont - map coloring for fill overlay (default black)
fc - map coloring for fill overlay
index - plot segment index and color segments
lalo=la:lo - plot lat/lon lines: la=latitude offset, lo=longitude offset
default - sets up object as default map
under - sets up object as an underlay map
over - sets up object as an overlay map

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), setColor(), setColorLatLon(), setColorLine(), setColorTable(), and setMapFiles().

Referenced by WXP::GridPlot::draw(), WXP::MosPlot::draw(), WXP::RawPlot::draw(), WXP::SfcPlot::draw(), WXP::UpaPlot::draw(), init(), and MapPlot().


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