FrameDir

class FrameDir

Frame Finder Class

Public Fields
typedef dmap_t::const_iterator file_iterator: File data iterator.

Public Methods
virtual ~FrameDir(void): FrameDir destructor.
FrameDir(void): Empty directory constructor.
FrameDir(const char* dir): Construct and fill a directory.
const ffData& find(const Time& t) const throw(NoData): Get file data by time.
gps_t getStart(gps_t time) const: find the next data segment.
gps_t getLast(gps_t time) const: Find the end of the next data segment.
int getDebug(void) const: Find the end of the n.
file_iterator begin(void) const: Get a iterator pointing to the seqential beginning.
file_iterator end(void) const: Get a iterator pointing to the directory end.
int size(void) const: size of file list.
bool empty(void) const: Test if file list is empty.
void add(const char* dir): Add one or more frame files.
void addFile(const char* File) throw(BadFile): Add a file to the FrameDir.
void clear(void): Delete all entries.
void erase(gps_t time): Delete a frame file entry.
void remove(const char* dir): Remove specified file descriptors.
void setDebug(int Level): Set debug level.

Documentation

The frame directory class is used to keep a directory of frame files in memory. Each frame is represented by an ffData object indexed by the starting GPS time. The data in the ffData structure are set as follows:

The start time is inferred from the last numeric string in the file name.
The frame length and number of frames are assumed to be the same as the preceding file if this is consistent with the time to the following file.
If the inferred time indicates a gap between a file and the following file, the starting time and frame length are read from the first frame header, and the number of frames in the file is read from the FrEndOfFile structure.
The frame file descriptors may be accessed sequentially using a file_iterator type variable.

typedef dmap_t::const_iterator file_iterator

Iterator provides sequential access to the data on the files in the directory.

virtual ~FrameDir(void)

Erase all FramDir entries.

FrameDir(void)

Construct an empty frame directory.

FrameDir(const char* dir)

Construct a Frame directory and fill it with data from files matching the specified specification. The frame file specification may contain wild-cards in the file name but not in the directory name.

Parameters:: dir - Frame file specification.

const ffData& find(const Time& t) const throw(NoData)

Get the data for the file that covers time t.

gps_t getStart(gps_t time) const

Get the start GPS of the first period on or after the specified time.

Returns:: Start time of the first data segment after the specified time.
Parameters:: time - Begin time for search.

gps_t getLast(gps_t time) const

Get the end GPS of the first period on or after the specified time.

Returns:: End time of the first data segment after the specified time.
Parameters:: time - Begin time for search.

int getDebug(void) const

Get the specified debug level.

Returns:: End time of the first data segment after the specified time.

file_iterator begin(void) const

Get a file_iterator pointing the first (earliest) frame file entry in the directory.

Returns:: A file_iterator pointing to the beginning of the directory.

file_iterator end(void) const

Get a file_iterator pointing the end of the frame file directory.

Returns:: A file_iterator pointing to the end of the directory.

int size(void) const

Return the number of entries in the file list.

bool empty(void) const

Test if the file list is empty.

void add(const char* dir)

Add all the specified frame files to the Frame Directory. The File specification can contain one or more wild cards in the File name but not in the directory name.

Parameters:: dir - File name(s) to be added to the FrameDir.

void addFile(const char* File) throw(BadFile)

Add a single file to the frame directory. The file name must be fully qualified, and must not contain any wild cards.

void clear(void)

Delete all file descriptors from the frameDir list.

void erase(gps_t time)

Delete the frame file descriptor for the specified time.

Parameters:: time - GPS time of start of

void remove(const char* dir)

Remove all specified files from a frame directory.

Parameters:: dir - Specification for files to be removed.

void setDebug(int Level)

Set the debug printout threshold to a specified level.

Parameters:: Level - New debug printout level.

This class has no child classes.

Author:: J. Zweizig
Version:: V1.0; Modified February 3, 2000

alphabetic index hierarchy of classes

generated by doc++