WXP C++ Library Version 6.74.6
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
WXP::ImagePlot Class Reference

This class plot satellite imagery. More...

#include "../include/ImagePlot.h"

Inheritance diagram for WXP::ImagePlot:
WXP::Drawing WXP::Listener

Public Types

enum  Type { UNK , IMAGE , GRIB , GRID }
 

Public Member Functions

 ImagePlot (const char *param)
 
int init ()
 
int setParam (const char *str)
 
int setPath (const char *path)
 
int setFile ()
 
int setInput (const char *type)
 
int setNameConv (const char *type)
 
int setType (const char *type)
 
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 setMap (bool val)
 
int getSync ()
 
int drawImage (Plot &plot, Image &rimage)
 
int draw (Plot &plot)
 
int draw (Plot &plot, const char *filename)
 
int draw (Plot &plot, Image &rimage)
 
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 plot satellite imagery.

Author
Dan Vietor

Member Function Documentation

◆ callback()

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

The event callback

Parameters
ev_strString containing description of event
ev_dataEvent specific data
dataUser specific data

Implements WXP::Listener.

References WXP::StrLib::equal(), WXP::Image::getPixel(), WXP::EarthPoint::set(), and WXP::Image::tran().

◆ draw()

int ImagePlot::draw ( Plot plot)
virtual

◆ drawImage()

int ImagePlot::drawImage ( Plot plot,
Image rimage 
)

◆ getDate()

int ImagePlot::getDate ( Date date)
virtual

Gets the current date of the data in the file

Return values
dateDate information

Implements WXP::Drawing.

References WXP::Filename::getDate().

◆ getDateOffset()

int ImagePlot::getDateOffset ( )
virtual

Gets the offset time between frames in loop

Return values
dateDate information

Implements WXP::Drawing.

◆ getDomain()

int ImagePlot::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
domainDefault domain

Implements WXP::Drawing.

References WXP::StrLib::equal(), WXP::Grid::getDomain(), WXP::Filename::getName(), WXP::Filename::getType(), WXP::GridWxpFile::isOpen(), WXP::ImageFile::isOpen(), WXP::GridWxpFile::open(), WXP::ImageFile::open(), WXP::FileAttr::READ, WXP::GridWxpFile::read(), and WXP::ImageFile::read().

◆ getInitDate()

int ImagePlot::getInitDate ( Date date)
virtual

Gets the initial date for a loop

Return values
dateDate information

Implements WXP::Drawing.

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

◆ getLoopType()

int ImagePlot::getLoopType ( )
virtual

Gets the available loop types

Returns
Loop type

Implements WXP::Drawing.

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

◆ getNumFrames()

int ImagePlot::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::ImagePlot::getSync ( )
inlinevirtual

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

Returns
Number of frames

Implements WXP::Drawing.

◆ init()

int ImagePlot::init ( )
virtual

Initializes object

Implements WXP::Drawing.

References WXP::Const::MISS, WXP::Timezone::set(), setFile(), setParam(), and setType().

◆ print()

int ImagePlot::print ( )
virtual

Method for printing class info

Implements WXP::Drawing.

◆ setColorFill()

int ImagePlot::setColorFill ( const char *  str)

Sets the color fill parameters

Parameters
strColor fill string

References WXP::String::set().

Referenced by WXP::MdrPlot::init(), WXP::RcmPlot::init(), WXP::RadPlot::setColorFill(), and setParam().

◆ setColorTable()

int ImagePlot::setColorTable ( const char *  str)

Sets the color table parameters

Parameters
strColor table parameter

References WXP::String::set().

Referenced by WXP::RadPlot::setColorTable(), and setParam().

◆ setFile()

int ImagePlot::setFile ( )
virtual

A method for setting basic file parameters

Implements WXP::Drawing.

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

Referenced by init().

◆ setFilename() [1/4]

int ImagePlot::setFilename ( )
virtual

A method for setting the default file for plotting

Implements WXP::Drawing.

References WXP::Filename::setFile().

Referenced by setParam().

◆ setFilename() [2/4]

int ImagePlot::setFilename ( const char *  str)
virtual

Sets the filename to be used.

Parameters
strThe filename to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [3/4]

int ImagePlot::setFilename ( Date date)
virtual

Sets the filename to use based on a specific date

Parameters
dateDate to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setFilename() [4/4]

int ImagePlot::setFilename ( Date date,
const char *  param 
)
virtual

Sets the filename to be used.

Parameters
dateThe initial date
paramThe parameters to use

Implements WXP::Drawing.

References WXP::Filename::setFile().

◆ setForeTime()

int WXP::ImagePlot::setForeTime ( const char *  fore)
inlinevirtual

Sets specific forecast time to plot

Parameters
foreForecast time

Implements WXP::Drawing.

◆ setInput()

int ImagePlot::setInput ( const char *  type)
virtual

Sets the input file type

Parameters
typeThe optional file type

Implements WXP::Drawing.

References WXP::Filename::setType().

Referenced by setFile(), and setParam().

◆ setNameConv()

int ImagePlot::setNameConv ( const char *  name)
virtual

Sets the file name convention

Parameters
nameThe optional file type

Implements WXP::Drawing.

References WXP::Filename::setNameConv().

Referenced by setFile(), and setParam().

◆ setParam()

int ImagePlot::setParam ( const char *  str)
virtual

◆ setType()

int ImagePlot::setType ( const char *  str)

Sets the product type

Parameters
strProduct type

References WXP::StrLib::copy().

Referenced by init().


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