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

This class plots city database data on a map. More...

#include "../include/CityPlot.h"

Inheritance diagram for WXP::CityPlot:
WXP::Drawing WXP::Listener

Public Member Functions

 CityPlot ()
 
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 *file)
 
int setFilename (Date &date)
 
int setFilename (Date &date, const char *param)
 
int setForeTime (const char *fore)
 
int getDate (Date &date)
 
int getDomain (Domain &domain)
 
int getInitDate (Date &date)
 
int getDateOffset ()
 
int getLoopType ()
 
int getNumFrames ()
 
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 city database data on a map.

Author
Dan Vietor

Constructor & Destructor Documentation

◆ CityPlot()

CityPlot::CityPlot ( )

Constructor. Initializes class data

References init().

Member Function Documentation

◆ callback()

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

Event callback

Implements WXP::Listener.

◆ draw()

int CityPlot::draw ( Plot plot)
virtual

◆ getDate()

int CityPlot::getDate ( Date date)
virtual

Gets the date of the datafile (not used)

Return values
dateDate class with date/time information

Implements WXP::Drawing.

References WXP::Date::init().

◆ getDateOffset()

int CityPlot::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getDomain()

int CityPlot::getDomain ( Domain domain)
virtual

Gets the default domain information for data

Return values
domainThe Domain class to return the domain information

Implements WXP::Drawing.

◆ getInitDate()

int CityPlot::getInitDate ( Date date)
virtual

Gets the initial date for a loop

Return values
dateDate information

Implements WXP::Drawing.

References WXP::Date::init().

◆ getLoopType()

int CityPlot::getLoopType ( )
virtual

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_NONE.

◆ getNumFrames()

int CityPlot::getNumFrames ( )
virtual

Gets the possible number of frames in a loop

Returns
Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::CityPlot::getSync ( )
inlinevirtual

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

Returns
Number of frames

Implements WXP::Drawing.

◆ init()

int CityPlot::init ( )
virtual

Initializes class data

Implements WXP::Drawing.

References setParam().

Referenced by CityPlot().

◆ print()

int CityPlot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setFile()

int CityPlot::setFile ( )
virtual

Sets the file types

Implements WXP::Drawing.

◆ setFilename() [1/4]

int CityPlot::setFilename ( )
virtual

Sets the filenames

Implements WXP::Drawing.

References WXP::FileTool::addPath(), WXP::Wxp::getDatabasePath(), and WXP::String::set().

Referenced by setFilename().

◆ setFilename() [2/4]

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

Sets the city database filename

Parameters
fileFilename to use

Implements WXP::Drawing.

References WXP::FileTool::addPath(), WXP::Wxp::getDatabasePath(), and WXP::String::set().

◆ setFilename() [3/4]

int CityPlot::setFilename ( Date date)
virtual

Sets the filename to use based on a specific date

Parameters
dateDate to use

Implements WXP::Drawing.

References setFilename().

◆ setFilename() [4/4]

int CityPlot::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 setFilename().

◆ setForeTime()

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

Sets forecast time (ignored)

Implements WXP::Drawing.

◆ setInput()

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

A method for setting input file type

Parameters
nameName convention to use

Implements WXP::Drawing.

◆ setNameConv()

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

A method for setting input file name convention

Parameters
nameName convention to use

Implements WXP::Drawing.

◆ setParam()

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

Sets the class parameters from string

Parameters
strString to parse for parameters

Implements WXP::Drawing.

References WXP::Strings::getInt(), WXP::Strings::getLength(), WXP::Strings::getNum(), WXP::Strings::getString(), and WXP::Strings::iequal().

Referenced by init().


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