WXP::LightFile Class Reference

This class reads in lightning data from file. More...

#include "../include/LightFile.h"

Public Types
enum	Type {   UNK , ALBANY , UNISYS , KAV ,   NOAA , GAIS , GAI_ASC , USPLN ,   USPLNT , USPLNB , VAISALA_ASC , NLDN_ASC }

Public Member Functions
	LightFile ()
	LightFile (const char *filename, int rtype)
int	init ()
int	open (const char *filename, int rtype)
bool	isOpen ()
int	close ()
int	read (LightData &data)

Static Public Member Functions
static int	getType (const char *str)

Detailed Description

This class reads in lightning data from file.

Author

Dan Vietor

Member Enumeration Documentation

Type

enum WXP::LightFile::Type

File type

Enumerator
UNK	Unknown type
ALBANY	SUNY Albany format
UNISYS	Unisys ASCII format
KAV	Kavouras format
NOAA	NOAAPORT format
GAIS	GAIS binary format
GAI_ASC	GAIS ASCII format
USPLN	USPLN ASCII format
USPLNT	Old USPLN Text format
USPLNB	USPLN binary format
VAISALA_ASC	Vaisala ASCII format
NLDN_ASC	NLDN ASCII format

Constructor & Destructor Documentation

LightFile() [1/2]

LightFile::LightFile

(

)

Constructor

References init().

LightFile() [2/2]

LightFile::LightFile	(	const char *	filename,
		int	rtype
	)

Constructor. Opens the file

Parameters

filename	The file name
rtype	The type of lightning file

References init(), and open().

Member Function Documentation

close()

int LightFile::close

(

)

Closes the file

References ALBANY, WXP::File::close(), GAI_ASC, GAIS, KAV, NLDN_ASC, NOAA, UNISYS, USPLN, USPLNB, and USPLNT.

Referenced by WXP::LightPlot::draw().

getType()

int LightFile::getType ( const char *  str )

static

Gets the file type

Parameters

str	The file type (albany, unisys, kav, gais, noaa, uspln)

References ALBANY, WXP::StrLib::equal(), GAI_ASC, GAIS, KAV, NLDN_ASC, NOAA, UNISYS, UNK, USPLN, USPLNB, USPLNT, and VAISALA_ASC.

Referenced by WXP::LightPlot::setInput(), and WXP::LightPlot::setNameConv().

init()

int LightFile::init

(

)

Initializes the object

References NOAA.

Referenced by LightFile(), and LightFile().

isOpen()

bool LightFile::isOpen

(

)

Returns true if file is open

Referenced by WXP::LightPlot::draw().

open()

int LightFile::open	(	const char *	filename,
		int	rtype
	)

Opens the input file

Parameters

filename	The file name
rtype	The lightning file type

References ALBANY, GAI_ASC, GAIS, WXP::Swap::init(), WXP::File::isOpen(), KAV, NLDN_ASC, NOAA, WXP::File::open(), WXP::Wxp::outWarning(), WXP::File::read(), WXP::File::seek(), WXP::File::skipLine(), UNISYS, USPLN, USPLNB, USPLNT, VAISALA_ASC, and WXP::Wxp::validLicense().

Referenced by WXP::LightPlot::draw(), and LightFile().

read()

int LightFile::read

(

LightData &

data

)

Reads data from the file

Return values

data	The output lightning data

References ALBANY, WXP::DateVal::day, GAI_ASC, GAIS, WXP::Date::get(), WXP::File::getLine(), WXP::DateVal::hour, KAV, WXP::DateVal::min, WXP::Const::MISS, WXP::DateVal::month, NLDN_ASC, NOAA, WXP::File::read(), WXP::File::scanf(), WXP::DateVal::sec, WXP::File::seek(), WXP::LightData::setDate(), WXP::Date::setDays(), WXP::LightData::setFsec(), WXP::Date::setHour(), WXP::LightData::setLat(), WXP::LightData::setLon(), WXP::Date::setMinute(), WXP::LightData::setMulti(), WXP::Date::setSecond(), WXP::LightData::setSignal(), UNISYS, USPLN, USPLNB, USPLNT, VAISALA_ASC, and WXP::DateVal::year.

Referenced by WXP::LightPlot::draw().

---

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

• LightFile.h
• LightFile.cc