This class plots satellite imagery. More...

#include "../include/SatPlot.h"

Inheritance diagram for WXP::SatPlot:

Public Member Functions
	SatPlot ()
	SatPlot (const char *param)
int	init ()
int	setParam (const char *str)
int	setPath (const char *path)
int	setFile ()
int	setInput (const char *rtype)
int	setOutput (const char *str)
int	setNameConv (const char *name)
int	setHour (const char *str)
int	setTimezone (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	getNumFrames ()
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getDomain (Domain &domain)
int	setColorTable (const char *str)
int	setColorFill (const char *str)
int	setModelMask (const char *str)
int	setCalibration (const char *str)
int	setMap (bool val)
int	getSync ()
int	maskModel (Image &image, Date &date)
int	saveImage (Image &image)
int	draw (Plot &plot, Image &bimage)
int	draw (Plot &plot)
void	callback (const char ev_str, const char ev_data, const void *data)
int	print ()

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 satellite imagery.

This class will read in a satellite image and plot data to a plot object.

syntax:
SatPlot splot;
splot.setParam( "parameters,..." );
splot.setFilename();
splot.draw( plot );

Author: Dan Vietor

Constructor & Destructor Documentation

◆ SatPlot() [1/2]

SatPlot::SatPlot ( )

Constructor. Initializes class

References init().

◆ SatPlot() [2/2]

SatPlot::SatPlot ( const char * param )

Constructor. Initializes class and sets parameters

Parameters

param The parameters to set

References init(), and setParam().

Member Function Documentation

◆ callback()

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

virtual

The event callback

Parameters

ev_str	String containing description of event
ev_data	Event specific data
data	User specific data

Implements WXP::Listener.

References WXP::StrLib::equal().

◆ draw()

int SatPlot::draw ( Plot & plot )

virtual

Method for plotting the actual data

Parameters

plot	The plot class specifying window and parameters for plotting

Implements WXP::Drawing.

References WXP::MapPlot::draw(), WXP::Filename::FILES, WXP::Wxp::isDebug(), WXP::SatFile::isOpen(), WXP::Wxp::outMessage(), WXP::Wxp::outWarning(), WXP::FileAttr::READ, WXP::SatFile::read(), WXP::SatFile::setCalibration(), WXP::SatFile::setDomain(), and WXP::SatFile::setMapRemove().

◆ getDate()

int SatPlot::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

◆ getDateOffset()

int SatPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

◆ getDomain()

int SatPlot::getDomain ( Domain & domain )

virtual

Gets the default domain

Return values

domain The default domain

Implements WXP::Drawing.

References WXP::SatFile::getHeader(), WXP::SatFile::isOpen(), WXP::SatFile::open(), and WXP::FileAttr::READ.

◆ getInitDate()

int SatPlot::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

◆ getLoopType()

int SatPlot::getLoopType ( )

virtual

Gets the available loop types

Returns: Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int SatPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

◆ getSync()

int WXP::SatPlot::getSync ( )

inlinevirtual

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

Returns: Number of frames

Implements WXP::Drawing.

◆ init()

int SatPlot::init ( )

virtual

Intializes the class

Implements WXP::Drawing.

References WXP::FileTool::checkPath(), WXP::Wxp::getDatabasePath(), WXP::Const::MISS, setColorFill(), setColorTable(), setFile(), setInput(), setNameConv(), setParam(), and setTimezone().

Referenced by SatPlot(), and SatPlot().

◆ print()

int SatPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColorFill()

int SatPlot::setColorFill ( const char * str )

Sets the color fill parameters

Parameters

str	Color fill string

Referenced by init(), and setParam().

◆ setColorTable()

int SatPlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters

str	Color table parameter

Referenced by init(), and setParam().

◆ setFile()

int SatPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

Referenced by init().

◆ setFilename() [1/4]

int SatPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

◆ setFilename() [2/4]

int SatPlot::setFilename ( const char * str )

virtual

Sets the filename to be used.

Parameters

str	The filename to use

Implements WXP::Drawing.

◆ setFilename() [3/4]

int SatPlot::setFilename ( Date & date )

virtual

Sets the filename to use based on a specific date

Parameters

date	Date to use

Implements WXP::Drawing.

◆ setFilename() [4/4]

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

virtual

Sets the filename to be used.

Parameters

str	The filename to use

Implements WXP::Drawing.

◆ setForeTime()

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

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

◆ setInput()

int SatPlot::setInput ( const char * str )

virtual

Sets the input file type

Parameters

type	The optional file type

Implements WXP::Drawing.

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

◆ setNameConv()

int SatPlot::setNameConv ( const char * name )

virtual

Sets the file name convention

Parameters

name	The optional file type

Implements WXP::Drawing.

References WXP::StrLib::valid().

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

◆ setParam()

int SatPlot::setParam ( const char * str )

virtual

Sets the parameters within the class:

Parameters

str	String to parse ct=file - Color table file co=color - Plotting color if=var - Input file name convention nc=var - Input file name convention ho=hour - Fix date parameters (ie hour of day) tz=zone - Zone information for label map - Plots a map sync - Specifes object as time sync

Implements WXP::Drawing.

References WXP::StrLib::copy(), WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), setColorFill(), setColorTable(), setInput(), setNameConv(), and setTimezone().

Referenced by init(), and SatPlot().

◆ setTimezone()

int SatPlot::setTimezone ( const char * str )

Sets the timezone for dates

Parameters

str Zone

Referenced by init(), and setParam().

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

SatPlot.h
SatPlot.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SatPlot() [1/2]

◆ SatPlot() [2/2]

Member Function Documentation

◆ callback()

◆ draw()

◆ getDate()

◆ getDateOffset()

◆ getDomain()

◆ getInitDate()

◆ getLoopType()

◆ getNumFrames()

◆ getSync()

◆ init()

◆ print()

◆ setColorFill()

◆ setColorTable()

◆ setFile()

◆ setFilename() [1/4]

◆ setFilename() [2/4]

◆ setFilename() [3/4]

◆ setFilename() [4/4]

◆ setForeTime()

◆ setInput()

◆ setNameConv()

◆ setParam()

◆ setTimezone()