BxTextFile.h

// ##################################################################
// Binx
// $Id: BxTextFile_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
//
// Super class for text file reading
// ##################################################################
/*

//  edikt::BinX
//  www.edikt.org
//  support@edikt.org

// Copyright (c) 2003 The University of Edinburgh.

*/

#ifndef __BxTextFile__
#define __BxTextFile__

#include "BxBinaryFile.h"

/*
 * Class managing external text data files (not in BinX version 1.0).
 * Not all application data files are stored in binary format.
 * This class manages and performs operations on external data files containing
 * data in ASCII or Unicode format.
 * <BR>Often, text data are separated by delimiters such as commas,
 * white spaces, and other control characters.
 * This breaks the application data into tokens.
 * The delimiters are defined as strings in the BinX document file
 * (which dscribes the format and structure of the external text data file).
 * Using the BinX document, data are read from or written to the text data file
 * based on the defined file structure.
 * <BR>This class is analygous to the serivces provided by the class BxBinaryFile.
 * The primary difference is that a different method of file I/O is used.
 * For text files, reading and writing are sequential.
 * Random access within the text data file, is possible, but it is not recommended.
 * <BR><B>Since:</B> Future release to be determined. 
 */
class DECLSPEC BxTextFile : public BxBinaryFile
{
public:
    BxTextFile();
    virtual ~BxTextFile();

    virtual char * className() const { return "BxTextFile"; } //<Returns the null-terminated string "BxTextFile".
};

#endif

---