WXP::SoundPlot Class Reference

This class plots a thermodynamic diagram. More...

#include "../include/SoundPlot.h"

Inheritance diagram for WXP::SoundPlot:

Public Member Functions
	SoundPlot (const char *param)
int	init ()
int	setType (int rtype)
int	setType (const char *str)
int	getType ()
int	setDiag (int val)
int	setParam (const char *str)
int	setFile ()
int	setInput (const char *type)
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	setId (const char *rid)
int	promptId ()
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	setLineColor (const char *str)
int	setParcelColor (const char *str)
int	getDomain (Domain &domain)
int	getSync ()
int	draw (Plot &plot)
int	draw (Plot &plot, UpaData &data)
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 a thermodynamic diagram.

Author

Dan Vietor

Member Function Documentation

callback()

void SoundPlot::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.

draw()

int SoundPlot::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::Wxp::checkMessage(), draw(), WXP::CityData::getElev(), WXP::ModelSpec::getName(), WXP::Strings::getNum(), WXP::StrLib::iequal(), WXP::CityTool::locate(), WXP::Wxp::outMessage(), WXP::Wxp::outWarning(), WXP::UpaFile::read(), WXP::CityTool::search(), WXP::EarthPoint::set(), WXP::ModelSpec::set(), WXP::Filename::setNameConv(), WXP::ModelSpec::valid(), and WXP::StrLib::valid().

Referenced by draw().

getDate()

int SoundPlot::getDate ( Date & date )

virtual

Gets the current date of the data in the file

Return values

date	Date information

Implements WXP::Drawing.

getDateOffset()

int SoundPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

getDomain()

int SoundPlot::getDomain ( Domain & domain )

virtual

A method for getting a default domain from the data. This is handy for data types that are for a specific domain like NIDS data.

Return values

domain

Default domain

Implements WXP::Drawing.

References WXP::ThermPlot::getDomain(), and WXP::Domain::set().

getInitDate()

int SoundPlot::getInitDate ( Date & date )

virtual

Gets the initial date for a loop

Return values

date	Date information

Implements WXP::Drawing.

getLoopType()

int SoundPlot::getLoopType ( )

virtual

Gets the available loop types

Returns

Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE, and WXP::Drawing::LOOP_FORE.

getNumFrames()

int SoundPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns

Number of frames

Implements WXP::Drawing.

getSync()

int WXP::SoundPlot::getSync ( )

inlinevirtual

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

Returns

Number of frames

Implements WXP::Drawing.

init()

int SoundPlot::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References setFile(), and setParam().

print()

int SoundPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

setFile()

int SoundPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

Referenced by init().

setFilename() [1/4]

int SoundPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

setFilename() [2/4]

int SoundPlot::setFilename ( const char * file )

virtual

A method for setting the default file for plotting

Parameters

file	Filename to use

Implements WXP::Drawing.

setFilename() [3/4]

int SoundPlot::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 SoundPlot::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.

setForeTime()

int SoundPlot::setForeTime ( const char * str )

virtual

Sets the forecast time to be used.

Parameters

str	The forecast time

Implements WXP::Drawing.

setInput()

int SoundPlot::setInput ( const char * type )

virtual

A method for setting input file type

Parameters

name	Name convention to use

Implements WXP::Drawing.

Referenced by setFile().

setNameConv()

int SoundPlot::setNameConv ( const char * name )

virtual

A method for setting input file name convention

Parameters

name	Name convention to use

Implements WXP::Drawing.

Referenced by setFile().

setParam()

int SoundPlot::setParam ( const char * str )

virtual

Sets specific parameters for the plot given a string

Parameters

str	String specifying parameters

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), and WXP::Strings::getStringAfter().

Referenced by init().

---

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

• SoundPlot.h
• SoundPlot.cc