TekFileASCII Class Reference

Inheritance diagram for TekFileASCII:

Inheritance graph
[legend]
Collaboration diagram for TekFileASCII:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TekFileASCII ()
 ~TekFileASCII ()
virtual TEKERR ReadLine (uchar_t **Buffer, unsigned long ReadMax)=0
virtual TEKERR WriteLine (const uchar_t *Buffer)=0
virtual TEKERR Close ()=0
virtual TEKERR Flush ()=0
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 Open ()=0
virtual TEKERR Open64 ()=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 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 is the interface defining the standard for accessing ASCII Files.

This interface is INHERITABLE.

Author:
Kevin McBride

Definition at line 38 of file tekfileascii.h.


Constructor & Destructor Documentation

TekFileASCII TekFileASCII  ) 
 

Instantizer.

Definition at line 42 of file TekFileASCII.cpp.

~TekFileASCII  ) 
 

Destructor.

Definition at line 48 of file TekFileASCII.cpp.


Member Function Documentation

TEKERR Close  )  [pure virtual]
 

Closes the file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 147 of file TekFileASCII.cpp.

TEKERR Flush  )  [pure virtual]
 

Flushes the buffer.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 169 of file TekFileASCII.cpp.

TEKERR get_FILE FILE **  FileDescriptor  )  [pure virtual]
 

Obtains the handle used to access the open file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 87 of file TekFileASCII.cpp.

TEKERR get_Filename uchar_t **  Name  )  [pure virtual]
 

Obtains the filename in the form of a uchar.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 98 of file TekFileASCII.cpp.

TEKERR get_Location unsigned long *  Location  )  [pure virtual]
 

Retrieves the location.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 280 of file TekFileASCII.cpp.

TEKERR get_Location64 uint64_t *  Location  )  [pure virtual]
 

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

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 292 of file TekFileASCII.cpp.

TEKERR get_Mode TekFileMode *  ModeID  )  [pure virtual]
 

Retrieves the mode currently set.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 158 of file TekFileASCII.cpp.

TEKERR get_Type TekFileType *  FileTypePointer  )  [pure virtual]
 

Gets the file type.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 136 of file TekFileASCII.cpp.

TEKERR Open  )  [pure virtual]
 

Open the file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 180 of file TekFileASCII.cpp.

TEKERR Open64  )  [pure virtual]
 

Open the file using 64 bit semantics.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 191 of file TekFileASCII.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
TekFileASCII::get_FILE()! Utilizing the descriptor in a direct fashion after a
successful call to put_FILE() will result in undefined results!!!!!

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 114 of file TekFileASCII.cpp.

TEKERR put_Filename uchar_t Name  )  [pure virtual]
 

Sets the filename to access.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 125 of file TekFileASCII.cpp.

TEKERR put_Mode TekFileMode  ModeID  )  [pure virtual]
 

Sets the mode used to open the file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 202 of file TekFileASCII.cpp.

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

Read from the file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 224 of file TekFileASCII.cpp.

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

Read from the file using 64 bit semantics.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 213 of file TekFileASCII.cpp.

TEKERR ReadLine uchar_t **  Buffer,
unsigned long  ReadMax
[pure virtual]
 

Reads up to ReadMax characters from a file and puts it in a uchar_t. The Buffer can be an already-created uchar_t, or can be a pointer to a uchar_t* to store the new uchar_t in.

NOTE: For optimization reasons, always let this function create the uchar_t for you. However, the same uchar_t can be passed in to this function without any problems.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 68 of file TekFileASCII.cpp.

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

Seek to another position of the file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 246 of file TekFileASCII.cpp.

TEKERR Seek64 TekFileSeek  SeekWhere,
int64_t  NewLocation
[pure virtual]
 

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

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 235 of file TekFileASCII.cpp.

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

Write to the file.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 268 of file TekFileASCII.cpp.

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

Write to the file using 64 bit semantics.

Implements TekFile.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 257 of file TekFileASCII.cpp.

TEKERR WriteLine const uchar_t Buffer  )  [pure virtual]
 

Writes a ascii-part of a uchar_t to the file.

Implemented in TekFileASCIIBare, and TekFileBZ2ASCII.

Definition at line 78 of file TekFileASCII.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 from TekFile.

Reimplemented in TekFileASCIIBare.

Definition at line 83 of file tekfileascii.h.


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