ldas-tools-diskcacheAPI  2.5.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
diskCache::Streams::IASCII Class Reference

#include <ASCII.hh>

Inheritance diagram for diskCache::Streams::IASCII:
diskCache::Streams::ASCII diskCache::Streams::IInterface diskCache::Streams::Interface

Classes

class  SwapError
 

Public Types

typedef Common::Registry::id_type id_type
 
typedef Interface::version_type version_type
 
typedef std::streamsize streamsize
 
typedef
LDASTools::AL::SharedPtr
< Streamable
read_return_type
 
typedef read_return_type(* read_func )(IASCII &Stream)
 
typedef INT_8U size_type
 
enum  version_tag_type {
  VERSION_NONE = 0x0000, VERSION_PROTOTYPE = 0xFFFF, VERSION_PRE_HEADER = 0x00FF, VERSION_HEADER = 0x0100,
  VERSION_MULTIPLE_EXTENSIONS = 0x0101, VERSION_ONLINE_STATUS = 0x0102, VERSION_GENERIC_INDEXES = 0x0103
}
 

Public Member Functions

 IASCII (std::istream &Source)
 
 ~IASCII ()
 
bool Readable () const
 
template<typename Type >
IASCIIoperator>> (Type &Data)
 
void clear (std::ios::iostate=std::ios::goodbit)
 
bool eof () const
 
version_type Version () const
 

Static Public Member Functions

static read_func Reader (id_type Id)
 
static void Reader (id_type Id, read_func Function)
 

Protected Member Functions

void version (version_type Version)
 

Protected Attributes

std::istream & m_stream
 

Member Typedef Documentation

typedef read_return_type(* diskCache::Streams::IASCII::read_func)(IASCII &Stream)
typedef LDASTools::AL::SharedPtr< Streamable > diskCache::Streams::IASCII::read_return_type
typedef INT_8U diskCache::Streams::ASCII::size_type
inherited
typedef std::streamsize diskCache::Streams::IASCII::streamsize

Member Enumeration Documentation

Enumerator
VERSION_NONE 

Version before the header was introduced.

VERSION_PROTOTYPE 

Version reserved for disk cache development.

Production systems and programs should never try to interpret or generate streams of this version. It is reserved for development purposes when the cache stream is being extended.

VERSION_PRE_HEADER 

version without the header information

This version number is hear to create versions of the cache file without versioning headers.

VERSION_HEADER 

First version with the header information.

This is when the header first appeared in the cache file.

All subsequent version numbers must be greater than this which means that 0x0001 - 0x00FF are all invalid values.

VERSION_MULTIPLE_EXTENSIONS 

Introduction of multiple file extensions.

Multiple file extensions allows for indexing of files in the S-D-G-T form that do not end in .gwf

Note
This mode is still under development and should not be used.
VERSION_ONLINE_STATUS 

Introduction of online status.

File contains online status field.

Note
This mode is still under development and should not be used.
VERSION_GENERIC_INDEXES 

Introduction of generic indexes.

Generic indexes allow for caching more than files of the type S-D-G-T.gwf

Note
This mode is still under development and should not be used.

Constructor & Destructor Documentation

diskCache::Streams::IASCII::IASCII ( std::istream &  Source)
diskCache::Streams::IASCII::~IASCII ( )

Member Function Documentation

void diskCache::Streams::IInterface::clear ( std::ios::iostate  State = std::ios::goodbit)
inlineinherited
bool diskCache::Streams::IInterface::eof ( ) const
inlineinherited
template<typename Type >
IASCII& diskCache::Streams::IASCII::operator>> ( Type &  Data)
bool diskCache::Streams::IASCII::Readable ( ) const
static read_func diskCache::Streams::IASCII::Reader ( id_type  Id)
static
static void diskCache::Streams::IASCII::Reader ( id_type  Id,
read_func  Function 
)
static
Interface::version_type diskCache::Streams::Interface::Version ( ) const
inlineinherited
void diskCache::Streams::Interface::version ( version_type  Version)
inlineprotectedinherited

Member Data Documentation

std::istream& diskCache::Streams::IInterface::m_stream
protectedinherited

The documentation for this class was generated from the following file: