This class plots raw data from file. More...

#include "../include/RawPlot.h"

Inheritance diagram for WXP::RawPlot:

Public Member Functions
	RawPlot (const char *param)

int	init ()

int	setParam (const char *str)

int	setPath (const char *path)

int	setFile ()

int	setNameConv (const char *type)

int	setHour (const char *str)

int	setInput (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	setMap (bool val)

int	getDate (Date &date)

int	getInitDate (Date &date)

int	getDateOffset ()

int	getLoopType ()

int	getNumFrames ()

int	getDomain (Domain &domain)

int	getSync ()

int	setColor (const char *str)

int	setVariable (const char *str)

int	setPlotType (const char *type)

int	setTimezone (const char *zone)

int	draw (Plot &plot)

int	draw (Plot &plot, const char filename, const char field, const char *param)

int	draw (Plot &plot, const char *filename)

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 raw data from file.

Author: Dan Vietor

Member Function Documentation

◆ callback()

void RawPlot::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 RawPlot::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::addOutPath(), WXP::StrLib::append(), WXP::ContPlot::BOTH, WXP::RawGrid::compute(), WXP::StrLib::copy(), WXP::DateTool::createLabel(), WXP::ContPlot::decodeType(), WXP::MapPlot::draw(), WXP::DatumPlot::draw(), WXP::StrLib::equal(), WXP::ContPlot::FILL, WXP::String::get(), WXP::Datum::getData(), WXP::Datum::getLoc(), WXP::Filename::getName(), WXP::Wxp::isDebug(), WXP::Domain::isSet(), WXP::ContPlot::LINE, WXP::Const::MISS, WXP::Wxp::outMessage(), WXP::Filename::setFile(), WXP::MapPlot::setFillCont(), WXP::MapPlot::setParam(), WXP::String::valid(), and WXP::ContPlot::VALUE.

◆ getDate()

int RawPlot::getDate ( Date & date )

virtual

Gets the date information from the input file

Return values

date	Date values

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int RawPlot::getDateOffset ( )

virtual

Gets the offset time between frames in loop

Return values

date	Date information

Implements WXP::Drawing.

◆ getDomain()

int RawPlot::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::DomainTool::set().

◆ getInitDate()

int RawPlot::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 RawPlot::getLoopType ( )

virtual

Gets the available loop types

Returns: Loop type

Implements WXP::Drawing.

References WXP::Drawing::LOOP_DATE.

◆ getNumFrames()

int RawPlot::getNumFrames ( )

virtual

Gets the possible number of frames in a loop

Returns: Number of frames

Implements WXP::Drawing.

References WXP::Filename::getNumFiles().

◆ getSync()

int WXP::RawPlot::getSync ( )

inlinevirtual

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

Returns: Number of frames

Implements WXP::Drawing.

◆ init()

int RawPlot::init ( )

virtual

Initializes object

Implements WXP::Drawing.

References WXP::DatumPlot::init(), WXP::Const::MISS, setFile(), setNameConv(), and setParam().

◆ print()

int RawPlot::print ( )

virtual

Method for printing class info

Implements WXP::Drawing.

◆ setFile()

int RawPlot::setFile ( )

virtual

A method for setting basic file parameters

Implements WXP::Drawing.

References setInput(), and setNameConv().

Referenced by init().

◆ setFilename() [1/4]

int RawPlot::setFilename ( )

virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [2/4]

int RawPlot::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 RawPlot::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 RawPlot::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::RawPlot::setForeTime ( const char * fore )

inlinevirtual

Sets specific forecast time to plot

Parameters

fore	Forecast time

Implements WXP::Drawing.

◆ setInput()

int RawPlot::setInput ( const char * type )

virtual

Sets the input file type

Parameters

type	The optional file name convention

Implements WXP::Drawing.

Referenced by setFile().

◆ setNameConv()

int RawPlot::setNameConv ( const char * type )

virtual

Sets the file name convention

Parameters

type	The optional file name convention

Implements WXP::Drawing.

References WXP::Filename::setNameConv(), and WXP::Filename::setNumFiles().

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

◆ setParam()

int RawPlot::setParam ( const char * str )

virtual

Sets the plotting parameters

Parameters

str Parameter string
nc=name - Name convention on input file
if=name - Name convention on input file
va=var - Variable to extract from raw file
tz=zone - Timezone to use in labels
pl=type - Plot type (data, cf, lcf, etc)
max=val - Plots only values less than val
min=val - Plots only values greater than val
sync - Sets object as time sync

See also: RawGrid::setParam DatumPlot::setParam GridCont::setParam

Implements WXP::Drawing.

References WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), setNameConv(), WXP::DatumPlot::setParam(), WXP::GridCont::setParam(), and WXP::RawGrid::setParam().

Referenced by init().

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

RawPlot.h
RawPlot.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ callback()

◆ draw()

◆ getDate()

◆ getDateOffset()

◆ getDomain()

◆ getInitDate()

◆ getLoopType()

◆ getNumFrames()

◆ getSync()

◆ init()

◆ print()

◆ setFile()

◆ setFilename() [1/4]

◆ setFilename() [2/4]

◆ setFilename() [3/4]

◆ setFilename() [4/4]

◆ setForeTime()

◆ setInput()

◆ setNameConv()

◆ setParam()