Provides a C++ object interface to the routine LWS Error tracking facilities.

Inheritance:

Public Methods

	LwsBase () Object creator.
	~LwsBase () Object destructor.
void	Clean () Clean will free up malloc'ed memory, except for the filter array malloc'ed by Build.
void	Setup () Setup will set up the object, making sure we have enough memory.
void	SetErrorMessage ( string newErrorMessage) Set a new error message.
void	AppendErrorMessage ( string nextErrorMessage ) Append an error message to the existing error message.
string	GetPreviousErrorMessage () Returns the error message that occurred before this one
string	GetErrorMessage ( ) GetErrorMessage will return a string describing what the most recent error was.
void	StdOut ( float* output, long numberOfSamples ) Will put the given trace output on both standard output.
void	StdFileOut ( float* output, long numberOfSamples, string outputFileName="lastDataOutput" ) Will put the given trace output on both standard output and into the file name given.
void	FileOut ( float* output, long numberOfSamples, string outputFileName="lastDataOutput" ) Will put the given trace output to the file outputFileName
float*	GetFileInput ( string inputFileName, long* numberOfSamples ) Get data from the given input file.
string	GetTempName ( string seed = "ktmp") Returns a unique temporary file name of the form seedxxxxxx in the /tmp directory.

Private Fields

string	previousError The string associated with the previos error encountered in this class.
string	currentError The string of the current error.

Documentation

Provides a C++ object interface to the routine LWS Error tracking facilities.

LwsBase()

Object creator. You can provide the filter parameters here, or settle for the defaults.

Parameters:

none. -

Returns:

none.

~LwsBase()

Object destructor. Frees up the objects memory. Does not free up the array returned by build. The latter is the user's responsibility.

Parameters:

none. -

Returns:

none.

void Clean()

Clean will free up malloc'ed memory, except for the filter array malloc'ed by Build.

Parameters:

none. -

Returns:

none.

void Setup()

Setup will set up the object, making sure we have enough memory.

Parameters:

none. -

Returns:

none.

void SetErrorMessage( string newErrorMessage)

Set a new error message.

Parameters:

newErrorMessage - will overwrite any existing error message.

Returns:

none

void AppendErrorMessage( string nextErrorMessage )

Append an error message to the existing error message.

Parameters:

nextErrorMessage - ;

Returns:

none.

string GetPreviousErrorMessage()

Returns the error message that occurred before this one

string GetErrorMessage( )

GetErrorMessage will return a string describing what the most recent error was.

Parameters:

none. -

Returns:

string errorMessage, a character string with the error message, which must be free'd by the caller.

void StdOut( float* output, long numberOfSamples )

Will put the given trace output on both standard output.

Parameters:

output - the data that will be output.
- numberOfSamples is (ahem) the number of samples in the data.

Returns:

none.

void StdFileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )

Will put the given trace output on both standard output and into the file name given.

Parameters:

output - the data that will be output.
- numberOfSamples is (ahem) the number of samples in the data.
outputFileName - is the name of the output file, with a default value of "lastDataOutput"

Returns:

none.

void FileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )

Will put the given trace output to the file outputFileName

Parameters:

output - the data that will be output.
- numberOfSamples is (ahem) the number of samples in the data.
outputFileName - is the name of the output file, with a default value of "lastDataOutput"

Returns:

none.

float* GetFileInput( string inputFileName, long* numberOfSamples )

Get data from the given input file.

Parameters:

inputFileName - is the name of the input file.
- numberOfSamples is the number of samples on the input.

Returns:

an array containing the input data, which the user must delete.

string GetTempName( string seed = "ktmp")

Returns a unique temporary file name of the form seedxxxxxx in the /tmp directory.

Parameters:

seed - is the string used to start off the temporary file name.

Returns:

tempoararyFileName, the fully qualified name of the temporary file.

string previousError

The string associated with the previos error encountered in this class. This is the error message before the last change. It provides some rollback.

string currentError

The string of the current error. If blank, there is no error.

Direct child classes:

LwsVector
LwsConv
GenButterworth

Alphabetic index HTML hierarchy of classes or Java

Copyright 1993, 1994 Geophysical Software, Inc.

2603 Peninsulas Drive, Missouri City Texas 77459, (713)438-0583.

All Rights Reserved Company Confidential

Prepared for University of Minnesota, October, 2001