WXP::WmoIngest Class Reference

This class ingests WMO formated data (see NOAAPORT/FOS). More...

#include "../include/WmoIngest.h"

Public Member Functions
	WmoIngest ()
int	init ()
int	setParam (const char *str)
int	setProdFile (const char *name)
int	setLogFile (const char *name)
int	setDate (Date &rdate)
int	terminate ()
int	printLog (const char *mess,...)
int	readProdFile (const char *filename)
int	readProdFile ()
int	isSelected ()
int	cleanLine (char *line, int len, int flag)
int	setAction (const char *command, int offset, char *string, int len)
int	action ()
int	close ()
int	saveHeader (const char *fullhead, const char *header, const char *header2)
int	saveLine (unsigned char *line, int size)
int	sendPAN ()
int	process (const char *filename)
int	checkProcessing ()

Detailed Description

This class ingests WMO formated data (see NOAAPORT/FOS).

Author

Dan Vietor

Constructor & Destructor Documentation

WmoIngest()

WmoIngest::WmoIngest

(

)

Constructor

References init().

Member Function Documentation

action()

int WmoIngest::action

(

)

Perform action on data

References action(), WXP::Product::APPEND, WXP::Wxp::isDebug(), WXP::Wxp::outMessage(), WXP::Product::PIPE, printLog(), setAction(), and WXP::Product::WRITE.

Referenced by action(), close(), isSelected(), process(), and readProdFile().

checkProcessing()

int WXP::WmoIngest::checkProcessing ( )

inline

Returns if object still processing data

cleanLine()

int WmoIngest::cleanLine	(	char *	line,
		int	len,
		int	flag )

Cleans a line, stripping non-printable characters

Parameters

line	The string to clean
len	The length of the string
flag	Type of cleaning. 1=strip, retain newline, 2=strip, retain carriage return and newline, 3=strip and convert "/" to "-" for header processing.

Referenced by saveLine(), and setAction().

close()

int WmoIngest::close

(

)

Closes open files

References action(), and WXP::Product::APPEND.

Referenced by process().

init()

int WmoIngest::init

(

)

Initializes the class

References setLogFile(), setParam(), and setProdFile().

Referenced by WmoIngest().

isSelected()

int WmoIngest::isSelected

(

)

Determines if a WMO header is selected to be processed. Header is stored in header and header2.

Returns

1=found, 0=not found

References action(), WXP::StrLib::equal(), and WXP::Product::NONE.

Referenced by process().

printLog()

int WmoIngest::printLog	(	const char *	mess,
			... )

Prints information to log file

Parameters

mess	The message to write to log file. This can be a format to be passed to vsprintf.

References WXP::FileTool::addPath(), WXP::File::close(), WXP::StrLib::equal(), WXP::String::get(), WXP::NameConvFile::getFilename(), WXP::File::isOpen(), WXP::File::open(), WXP::File::printf(), WXP::NameConv::set(), and WXP::NameConv::setFile().

Referenced by action(), process(), readProdFile(), saveLine(), and terminate().

process()

int WmoIngest::process

(

const char *

filename

)

Processes data in data stream, extracts header, checks product file for action and saves data to file/program.

Parameters

filename

The filename to process.

References action(), WXP::StrLib::append(), WXP::StrLib::bcopy(), close(), WXP::StrLib::copy(), WXP::StrLib::equal(), WXP::Wxp::isDebug(), isSelected(), WXP::Wxp::outDebug(), WXP::Wxp::outMessage(), printLog(), readProdFile(), saveHeader(), saveLine(), sendPAN(), WXP::ForeTime::toCode(), WXP::Variable::toIndCode(), WXP::Level::toLevelCode(), WXP::Level::toTypeCode(), and WXP::StrLib::trimWS().

readProdFile() [1/2]

int WmoIngest::readProdFile

(

)

Reads the product file into memory

References readProdFile().

Referenced by process(), and readProdFile().

readProdFile() [2/2]

int WmoIngest::readProdFile

(

const char *

name

)

Reads the product file into memory

Parameters

name	The product file name

References action(), WXP::FileTool::addPath(), WXP::Product::APPEND, WXP::File::close(), WXP::StrLib::copy(), WXP::StrLib::equal(), WXP::Product::FILE, WXP::String::get(), WXP::Wxp::getDatabasePath(), WXP::File::getLine(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::StrLib::iequal(), WXP::File::isOpen(), WXP::Product::NONE, WXP::File::open(), WXP::Wxp::outMessage(), WXP::Product::PIPE, printLog(), WXP::Product::RUN, WXP::Strings::set(), WXP::StrLib::toInt(), WXP::StrLib::trimWS(), and WXP::Product::WRITE.

saveHeader()

int WmoIngest::saveHeader	(	const char *	fullhead,
		const char *	header,
		const char *	header2 )

Saves the WMO header to output file/program

Parameters

fullhead	The full header with control characters
header	The actual WMO header
header2	The secondary header (AWIPS header)

Referenced by process().

saveLine()

int WmoIngest::saveLine	(	unsigned char *	line,
		int	size )

Saves a line to the output file/program

Parameters

line	The line of data
size	The number of bytes in line

References cleanLine(), and printLog().

Referenced by process().

sendPAN()

int WmoIngest::sendPAN

(

)

Sends a PAN (Product Arrival Notification) to the end user.

References WXP::Product::APPEND, WXP::File::close(), WXP::File::isOpen(), WXP::Wxp::outDebug(), WXP::Product::PIPE, WXP::File::printf(), and WXP::Product::WRITE.

Referenced by process().

setAction()

int WmoIngest::setAction	(	const char *	command,
		int	offset,
		char *	string,
		int	len )

Sets up action string using wildcard characters in command string.

Parameters

command	The command string to interpret
offset	Offset time by this amount (-sec)

Return values

string

Output string

Parameters

len	Length of output string

References WXP::Date::addSeconds(), WXP::Date::adjustMinute(), cleanLine(), WXP::DateVal::day, WXP::Date::get(), WXP::Date::getJulian(), WXP::DateTool::getMonthLower(), WXP::DateVal::hour, WXP::StrLib::lowCase(), WXP::DateVal::min, WXP::DateVal::month, WXP::Date::set(), WXP::StrLib::upCase(), and WXP::DateVal::year.

Referenced by action().

setLogFile()

int WmoIngest::setLogFile

(

const char *

name

)

Sets the log file name

Parameters

name	The log file name

Referenced by init(), and setParam().

setParam()

int WmoIngest::setParam

(

const char *

str

)

Sets class parameters

Parameters

str	String with parameters to set

References WXP::Strings::equal(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getStringAfter(), setLogFile(), and setProdFile().

Referenced by init().

setProdFile()

int WmoIngest::setProdFile

(

const char *

name

)

Sets the product file name

Parameters

name	The product file name

Referenced by init(), and setParam().

terminate()

int WmoIngest::terminate

(

)

Terminates ingest. If idle, exits program, otherwise sets flag to end ingest after product is transmitted.

References WXP::Wxp::exit(), WXP::Wxp::NOERR, and printLog().

---

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

• WmoIngest.h
• WmoIngest.cc