WXP::UpaXSectPlot Class Reference

This class plots cross sections. More...

#include "../include/UpaXSectPlot.h"

Inheritance diagram for WXP::UpaXSectPlot:

List of all members.

Public Types
enum	Type { SPATIAL, TIME }
Public Member Functions
int	setParam (const char *str)
int	setFile ()
int	setInput (const char *type)
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	promptId ()
int	getDate (Date &date)
int	getInitDate (Date &date)
int	getDateOffset ()
int	getLoopType ()
int	getNumFrames ()
int	getDomain (Domain &domain)
int	draw (Plot &plot)
void	callback (const char *ev_str, const char *ev_data, const void *data)
int	print ()

---

Detailed Description

This class plots cross sections.

Author:

Dan Vietor

---

Member Function Documentation

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

int UpaXSectPlot::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::Plot::addLabel(), WXP::FileTool::addPath(), WXP::String::append(), WXP::Domain::calcEarthDist(), WXP::Plot::drawFormText(), WXP::Plot::drawLine(), WXP::String::get(), WXP::CityData::getId(), WXP::CityData::getLat(), WXP::CityData::getLon(), WXP::Filename::getName(), WXP::Strings::getNum(), WXP::Filename::getNumFiles(), WXP::Strings::getString(), WXP::StrLib::iequal(), WXP::Const::MISS, WXP::Wxp::outMessage(), WXP::String::print(), WXP::String::printf(), WXP::VCoord::set(), WXP::Point::set(), WXP::EarthPoint::set(), WXP::Strings::set(), WXP::Filename::setFile(), WXP::Plot::setFill(), WXP::Plot::setLine(), WXP::Filename::setNumFiles(), and WXP::Plot::setText().

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

int UpaXSectPlot::getDateOffset

(

)

[virtual]

Gets the offset time between frames in loop

Return values:

date

Date information

Implements WXP::Drawing.

int UpaXSectPlot::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::Domain::init().

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

int UpaXSectPlot::getLoopType

(

)

[virtual]

Gets the available loop types

Returns:

Loop type

Implements WXP::Drawing.

int UpaXSectPlot::getNumFrames

(

)

[virtual]

Gets the possible number of frames in a loop

Returns:

Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

int UpaXSectPlot::print

(

)

[virtual]

Method for printing class info

Implements WXP::Drawing.

int UpaXSectPlot::setFile

(

)

[virtual]

A method for setting basic file parameters

Implements WXP::Drawing.

References setNameConv().

int UpaXSectPlot::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::setDate().

int UpaXSectPlot::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::setDate().

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

int UpaXSectPlot::setFilename

(

)

[virtual]

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFilePrompt().

int WXP::UpaXSectPlot::setForeTime

(

const char *

fore

)

[inline, virtual]

Sets specific forecast time to plot

Parameters:

fore

Forecast time

Implements WXP::Drawing.

int UpaXSectPlot::setInput

(

const char *

type

)

[virtual]

A method for setting input file type

Parameters:

name

Name convention to use

Implements WXP::Drawing.

int UpaXSectPlot::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::setNameConv().

Referenced by setFile().

int UpaXSectPlot::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::getNum().

---

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

• UpaXSectPlot.h
• UpaXSectPlot.cc