This class plots lightning data. More...

#include "../include/LightPlot.h"

Inheritance diagram for WXP::LightPlot:

Public Member Functions
	LightPlot ()

	LightPlot (const char *param)

int	init ()

int	setParam (const char *str)

int	setPath (const char *path)

int	setFile ()

int	setInput (const char *str)

int	setNameConv (const char *name)

int	setHour (const char *str)

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	setValidDate (const char *str)

int	setValidDate (Date &date)

int	getDateOffset ()

int	getLoopType ()

int	getNumFrames ()

int	getDomain (Domain &domain)

int	getSync ()

int	setColorTable (const char *str)

int	setColor (const char *str)

int	setColorFill (const char *str)

int	setScale (float val)

int	setTimezone (const char *str)

int	setMap (bool val)

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 lightning data.

Author: Dan Vietor

Constructor & Destructor Documentation

◆ LightPlot() [1/2]

LightPlot::LightPlot ( )

Constructor

References init().

◆ LightPlot() [2/2]

LightPlot::LightPlot ( const char * param )

Constructor. Sets parameters

Parameters

param The parameters

References init(), and setParam().

Member Function Documentation

◆ callback()

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

virtual

Sets the callback for processing data from display

Parameters

ev_str	The event type
ev_data	The event data such as cursor location
data	The user defined data attached to event

Implements WXP::Listener.

◆ draw()

int LightPlot::draw ( Plot & plot )

virtual

Plots the lightning data

Parameters

plot	The plot object

Implements WXP::Drawing.

References WXP::Plot::addLabel(), WXP::Wxp::checkMessage(), WXP::LightFile::close(), WXP::DateTool::createLabel(), WXP::MapPlot::draw(), WXP::Plot::drawMark(), WXP::Plot::drawText(), WXP::StrLib::equal(), WXP::LightFile::GAI_ASC, WXP::LightFile::GAIS, WXP::String::get(), WXP::Plot::getColorMap(), WXP::LightData::getDate(), WXP::Filename::getDate(), WXP::Date::getHour(), WXP::LightData::getLat(), WXP::LightData::getLon(), WXP::Date::getMinute(), WXP::LightData::getMinute(), WXP::LightData::getMulti(), WXP::Filename::getName(), WXP::Filename::getNumFiles(), WXP::Date::getSecond(), WXP::Date::getSeconds(), WXP::LightData::getSeconds(), WXP::LightData::getSignal(), WXP::Date::init(), WXP::LightFile::isOpen(), WXP::Date::isSet(), WXP::LightFile::KAV, WXP::LightFile::NLDN_ASC, WXP::LightFile::NOAA, WXP::LightFile::open(), WXP::Wxp::outMessage(), WXP::Date::print(), WXP::LightData::print(), WXP::ColorFile::read(), WXP::LightFile::read(), WXP::EarthPoint::set(), WXP::Plot::setColorMap(), WXP::Filename::setFile(), WXP::Plot::setMark(), WXP::Filename::setNumFiles(), WXP::Plot::setText(), WXP::LightFile::UNISYS, WXP::LightFile::USPLN, WXP::LightFile::USPLNB, WXP::LightFile::USPLNT, WXP::LightFile::VAISALA_ASC, WXP::String::valid(), and WXP::DateRange::valid().

◆ getDate()

int LightPlot::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int LightPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

◆ getDomain()

int LightPlot::getDomain ( Domain & domain )

virtual

Gets the default domain for plotting

Parameters

domain The domain specification

Implements WXP::Drawing.

References WXP::DomainTool::set().

◆ getInitDate()

int LightPlot::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

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

◆ getLoopType()

int LightPlot::getLoopType ( )

virtual

Gets the available loop types

Returns: Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int LightPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::LightPlot::getSync ( )

inlinevirtual

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

Returns: Number of frames

Implements WXP::Drawing.

◆ init()

int LightPlot::init ( )

virtual

Initializes the ojbect

Implements WXP::Drawing.

References WXP::Date::init(), WXP::LightFile::NOAA, setColor(), setColorFill(), setColorTable(), setFile(), setNameConv(), setParam(), setScale(), and setTimezone().

Referenced by LightPlot(), and LightPlot().

◆ print()

int LightPlot::print ( )

virtual

Prints the object parameters

Implements WXP::Drawing.

◆ setColor()

int LightPlot::setColor ( const char * str )

Sets the color parameters

Parameters

str	Color string

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorFill()

int LightPlot::setColorFill ( const char * str )

Sets the color fill parameters. Used to color lightning strikes based on value.

Parameters

str	The colors

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorTable()

int LightPlot::setColorTable ( const char * str )

Sets the color table

Parameters

str	Color table

References WXP::String::set().

Referenced by init(), and setParam().

◆ setFile()

int LightPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

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

Referenced by init().

◆ setFilename() [1/4]

int LightPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [2/4]

int LightPlot::setFilename ( const char * file )

virtual

A method for setting the default file for plotting

Parameters

file	Filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/4]

int LightPlot::setFilename ( Date & date )

virtual

Sets the filename to use based on a specific date

Parameters

date	Date to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/4]

int LightPlot::setFilename	(	Date &	date,
		const char *	param
	)

virtual

Sets the filename to use based on a specific date and parameters

Parameters

date	Date to use
param	Parameters to use for offset to date

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setForeTime()

int WXP::LightPlot::setForeTime ( const char * fore )

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

◆ setHour()

int LightPlot::setHour ( const char * str )

Sets the specific file time

Parameters

str	The file time (hour)

References WXP::Filename::setFixDate().

Referenced by setFile().

◆ setInput()

int LightPlot::setInput ( const char * type )

virtual

A method for setting input file type

Parameters

name	Name convention to use

Implements WXP::Drawing.

References WXP::LightFile::getType().

Referenced by setFile(), and setParam().

◆ setMap()

int WXP::LightPlot::setMap ( bool val )

inline

Sets whether object is to draw map or not

◆ setNameConv()

int LightPlot::setNameConv ( const char * name )

virtual

A method for setting input file name convention

Parameters

name	Name convention to use

Implements WXP::Drawing.

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

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

◆ setParam()

int LightPlot::setParam ( const char * str )

virtual

Sets the parameters within the class:

Parameters

str String to parse
min=## - Number of minutes to use in each plot
sc=## - Scale factor for markers
mark+- - Plot + and - for strikes based on signal
mark=type - Plot a marker for each strike
ct=file - Specifies a color table
co=color - Specifies the plot color
cof=colors - Specifies the fill colors
map - Specifies to draw a map
bar - Specifies to draw color bar
nobar - Specifies not to draw color bar
sync - Specifies object as a time sync

See also: PlotAttr::parseMarker

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::set(), setColor(), setColorFill(), setColorTable(), setInput(), setNameConv(), setScale(), setTimezone(), and setValidDate().

Referenced by init(), and LightPlot().

◆ setPath()

int LightPlot::setPath ( const char * path )

Sets up the path to the data files

Parameters

path	The directory path

References WXP::Filename::setPath().

◆ setScale()

int LightPlot::setScale ( float val )

Sets the plot scale factor. Used to scale markers.

Parameters

val	The scale factor

Referenced by init(), and setParam().

◆ setTimezone()

int LightPlot::setTimezone ( const char * str )

Sets the timezone for dates

Parameters

str Zone

References WXP::Timezone::set().

Referenced by init(), and setParam().

◆ setValidDate() [1/2]

int LightPlot::setValidDate ( const char * str )

Sets the valid date for which lightning will be displayed

Parameters

str	Date (yyyymmddhhnn)

References WXP::Date::set().

Referenced by setParam().

◆ setValidDate() [2/2]

int LightPlot::setValidDate ( Date & rdate )

Sets the valid date for which lightning will be displayed

Parameters

rdate Date

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

LightPlot.h
LightPlot.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LightPlot() [1/2]

◆ LightPlot() [2/2]

Member Function Documentation

◆ callback()

◆ draw()

◆ getDate()

◆ getDateOffset()

◆ getDomain()

◆ getInitDate()

◆ getLoopType()

◆ getNumFrames()

◆ getSync()

◆ init()

◆ print()

◆ setColor()

◆ setColorFill()

◆ setColorTable()

◆ setFile()

◆ setFilename() [1/4]

◆ setFilename() [2/4]

◆ setFilename() [3/4]

◆ setFilename() [4/4]

◆ setForeTime()

◆ setHour()

◆ setInput()

◆ setMap()

◆ setNameConv()

◆ setParam()

◆ setPath()

◆ setScale()

◆ setTimezone()

◆ setValidDate() [1/2]

◆ setValidDate() [2/2]