TekFile Class Reference

Inheritance diagram for TekFile:

Inheritance graph
[legend]
Collaboration diagram for TekFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TekFile ()
 ~TekFile ()
virtual TEKERR get_FILE (FILE **FileDescriptor)=0
virtual TEKERR get_Filename (uchar_t **Name)=0
virtual TEKERR get_Mode (TekFileMode *ModeID)=0
virtual TEKERR get_Type (TekFileType *FileTypePointer)=0
virtual TEKERR put_FILE (FILE *FileDescriptor)=0
virtual TEKERR put_Filename (uchar_t *Name)=0
virtual TEKERR put_Mode (TekFileMode ModeID)=0
virtual TEKERR Close ()=0
virtual TEKERR Flush ()=0
virtual TEKERR Open ()=0
virtual TEKERR Open64 ()=0
virtual TEKERR Read64 (void *Buffer, uint64_t BytesToRead, uint64_t *BytesRead)=0
virtual TEKERR Read (void *Buffer, unsigned long BytesToRead, unsigned long *BytesRead)=0
virtual TEKERR Seek64 (TekFileSeek SeekWhere, int64_t NewLocation)=0
virtual TEKERR Seek (TekFileSeek SeekWhere, signed long NewLocation)=0
virtual TEKERR Write64 (void *Buffer, uint64_t BytesToWrite, uint64_t *BytesWrote)=0
virtual TEKERR Write (void *Buffer, unsigned long BytesToWrite, unsigned long *BytesWrote)=0
virtual TEKERR get_Location (unsigned long *Location)=0
virtual TEKERR get_Location64 (uint64_t *Location)=0

Public Attributes

 TEKSTD_HEADER_VARS

Detailed Description

This interface defines the standard routines for any interface performing I/O on files, pipes, and sockets.

This interface is INHERITABLE.

Author:
Kevin McBride

Definition at line 108 of file tekfile.h.


Constructor & Destructor Documentation

TekFile TekFile  ) 
 

Instantizer.

Definition at line 137 of file TekFile.cpp.

~TekFile  ) 
 

Destructor.

Definition at line 145 of file TekFile.cpp.


Member Function Documentation

TEKERR Close  )  [pure virtual]
 

Closes the file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 222 of file TekFile.cpp.

TEKERR Flush  )  [pure virtual]
 

Flushes the buffer.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 244 of file TekFile.cpp.

TEKERR get_FILE FILE **  FileDescriptor  )  [pure virtual]
 

Obtains the handle used to access the open file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 162 of file TekFile.cpp.

TEKERR get_Filename uchar_t **  Name  )  [pure virtual]
 

Obtains the filename in the form of a uchar.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 173 of file TekFile.cpp.

TEKERR get_Location unsigned long *  Location  )  [pure virtual]
 

Retrieves the location.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 355 of file TekFile.cpp.

TEKERR get_Location64 uint64_t *  Location  )  [pure virtual]
 

Retrieves the location and stores it in a 64-bit variable.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 367 of file TekFile.cpp.

TEKERR get_Mode TekFileMode *  ModeID  )  [pure virtual]
 

Retrieves the mode currently set.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 233 of file TekFile.cpp.

TEKERR get_Type TekFileType *  FileTypePointer  )  [pure virtual]
 

Gets the file type.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 211 of file TekFile.cpp.

TEKERR Open  )  [pure virtual]
 

Open the file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 255 of file TekFile.cpp.

TEKERR Open64  )  [pure virtual]
 

Open the file using 64 bit semantics.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 266 of file TekFile.cpp.

TEKERR put_FILE FILE *  FileDescriptor  )  [pure virtual]
 

Sets the handle used to access a file.

WARNING!!!!! DO NOT USE THE FILE DESCRIPTOR YOU PASS IN
TO THIS FUNCTION UNLESS YOU HAVE RE-RETRIEVED IT USING
TekFile::get_FILE()! Utilizing the descriptor in a direct fashion after a
successful call to put_FILE() will result in undefined results!!!!!

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 189 of file TekFile.cpp.

TEKERR put_Filename uchar_t Name  )  [pure virtual]
 

Sets the filename to access.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 200 of file TekFile.cpp.

TEKERR put_Mode TekFileMode  ModeID  )  [pure virtual]
 

Sets the mode used to open the file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 277 of file TekFile.cpp.

TEKERR Read void *  Buffer,
unsigned long  BytesToRead,
unsigned long *  BytesRead
[pure virtual]
 

Read from the file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 299 of file TekFile.cpp.

TEKERR Read64 void *  Buffer,
uint64_t  BytesToRead,
uint64_t *  BytesRead
[pure virtual]
 

Read from the file using 64 bit semantics.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 288 of file TekFile.cpp.

TEKERR Seek TekFileSeek  SeekWhere,
signed long  NewLocation
[pure virtual]
 

Seek to another position of the file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 321 of file TekFile.cpp.

TEKERR Seek64 TekFileSeek  SeekWhere,
int64_t  NewLocation
[pure virtual]
 

Seek to another position of the file using 64 bit semantics.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 310 of file TekFile.cpp.

TEKERR Write void *  Buffer,
unsigned long  BytesToWrite,
unsigned long *  BytesWrote
[pure virtual]
 

Write to the file.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 343 of file TekFile.cpp.

TEKERR Write64 void *  Buffer,
uint64_t  BytesToWrite,
uint64_t *  BytesWrote
[pure virtual]
 

Write to the file using 64 bit semantics.

Implemented in TekFileASCII, TekFileASCIIBare, TekFileBinary, TekFileBZ2, TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 332 of file TekFile.cpp.


Member Data Documentation

TEKSTD_HEADER_VARS
 

This macro contains the generic implementation for TekStd.
It is much easier to use as opposed to creating the
implementation by hand.

Reimplemented in TekFileASCII, TekFileASCIIBare, and TekFileBinary.

Definition at line 166 of file tekfile.h.


The documentation for this class was generated from the following files: SourceForge.net Logo  Technical Library Template Interface Project Page