ucar.unidata.data.adt

Class History

java.lang.Object

ucar.unidata.data.adt.History

public class History
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static ucar.unidata.data.adt.IRHistoryRecord[]	HistoryFile
static int	HistoryFileRecords
static ucar.unidata.data.adt.IRHistoryRecord	IRCurrentRecord

Constructor Summary

Constructors

Constructor and Description
History()

Method Summary

Modifier and Type	Method and Description
static int	CommentHistoryRecords(java.lang.String CommentString) Insert comment in history file at specifified date/time.
static int[]	DeleteHistoryRecords(boolean RunFullAnalysis, java.lang.String HistoryFileName) Delete record(s) in a history file.
static int	HistoryNumberOfRecords()
static void	InitCurrent(boolean InitialFlagTF)
static int[]	InsertHistoryRecord(boolean RunFullAnalysis, java.lang.String HistoryFileName) Insert or overwrite a record in a history file.
static java.lang.String	ListHistory(int OutputStyle, int OutputFormatTypeID, java.lang.String ATCFFileSourceIDString, java.lang.String ATCFStormIDString) List the ASCII history file between given date/times.
void	ReadHistoryFile(java.lang.String filename)
static int	WriteHistoryFile(java.lang.String HistoryFileName) Write HistoryRecordPtr structure to ASCII history file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HistoryFileRecords

public static int HistoryFileRecords

HistoryFile

public static ucar.unidata.data.adt.IRHistoryRecord[] HistoryFile

IRCurrentRecord

public static ucar.unidata.data.adt.IRHistoryRecord IRCurrentRecord

Constructor Detail

History

public History()

Method Detail

HistoryNumberOfRecords

public static int HistoryNumberOfRecords()

ListHistory

public static java.lang.String ListHistory(int OutputStyle,
                                           int OutputFormatTypeID,
                                           java.lang.String ATCFFileSourceIDString,
                                           java.lang.String ATCFStormIDString)

List the ASCII history file between given date/times.

Parameters:

OutputStyle - Output one record (-1) or entire file (0).

OutputFormatTypeID - 0=ATCF, -1=History List.

ATCFFileSourceIDString - ATCF file source identifier.

ATCFStormIDString - ATCF storm identifier.

Returns:

Matching part of the ASCII history file.

InsertHistoryRecord

public static int[] InsertHistoryRecord(boolean RunFullAnalysis,
                                        java.lang.String HistoryFileName)

Insert or overwrite a record in a history file. Global structure HistoryRecordPtr will be modified and the ASCII history file will be rewritten in another routine.

Parameters:

RunFullAnalysis - Full analysis toggle.

HistoryFileName - File to modify.

Returns:

Array of two integers. The first value represents the number of inserted records. The second value is flag that describes the "type" of modification (possible values are 1, 2, 3, 4).

1. Overwritten
2. Inserted
3. Record placed at start of new history structure.
4. Record placed at end of existing history structure.

DeleteHistoryRecords

public static int[] DeleteHistoryRecords(boolean RunFullAnalysis,
                                         java.lang.String HistoryFileName)

Delete record(s) in a history file.

Routine will modify structure HistoryRecordPtr, which will then be rewritten to ASCII history file in another subroutine.

Parameters:

RunFullAnalysis - Full analysis toggle.

HistoryFileName - File to modify.

Returns:

Array containing two integer values. The first value is the number of modified records, and the seconds value is the number of deleted records.

CommentHistoryRecords

public static int CommentHistoryRecords(java.lang.String CommentString)

Insert comment in history file at specifified date/time.

Parameters:

CommentString - Character string field to be inserted.

Returns:

If -1, there was an error finding record, if >= 0 , number of modified records.

WriteHistoryFile

public static int WriteHistoryFile(java.lang.String HistoryFileName)
                            throws java.io.IOException

Write HistoryRecordPtr structure to ASCII history file.

Parameters:

HistoryFileName - File to write.

Returns:

If >= 0, the value represents the number of records written. If -2, there was an error reading HistoryFileName. If -3, there was an error writing HistoryFileName. Finally, if -5, there was an error closing HistoryFileName.

Throws:

java.io.IOException - if there was a problem writing to HistoryFileName.

InitCurrent

public static void InitCurrent(boolean InitialFlagTF)

ReadHistoryFile

public void ReadHistoryFile(java.lang.String filename)
                     throws java.io.IOException

Throws:

java.io.IOException