ldas-tools-diskcacheAPI  2.7.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
diskCache::Streams::IInterface Class Reference

Interface for input streams. More...

#include <StreamsInterface.hh>

Inheritance diagram for diskCache::Streams::IInterface:
Inheritance graph
[legend]
Collaboration diagram for diskCache::Streams::IInterface:
Collaboration graph
[legend]

Public Types

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, 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, 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
}
 
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, 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, 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
}
 
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, 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, 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
}
 
typedef INT_2U version_type
 
typedef INT_2U version_type
 
typedef INT_2U version_type
 

Public Member Functions

 IInterface (std::istream &Source)
 
void clear (std::ios::iostate=std::ios::goodbit)
 
bool eof () const
 
 IInterface (std::istream &Source)
 
void clear (std::ios::iostate=std::ios::goodbit)
 
bool eof () const
 
 IInterface (std::istream &Source)
 
void clear (std::ios::iostate=std::ios::goodbit)
 
bool eof () const
 
version_type Version () const
 
version_type Version () const
 
version_type Version () const
 

Protected Member Functions

void version (version_type Version)
 
void version (version_type Version)
 
void version (version_type Version)
 

Protected Attributes

std::istream & m_stream
 

Detailed Description

Interface for input streams.

Member Typedef Documentation

◆ version_type [1/3]

◆ version_type [2/3]

◆ version_type [3/3]

Member Enumeration Documentation

◆ version_tag_type [1/3]

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.
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.
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.

◆ version_tag_type [2/3]

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.
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.
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.

◆ version_tag_type [3/3]

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.
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.
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

◆ IInterface() [1/3]

diskCache::Streams::IInterface::IInterface ( std::istream &  Source)
inline

◆ IInterface() [2/3]

diskCache::Streams::IInterface::IInterface ( std::istream &  Source)

◆ IInterface() [3/3]

diskCache::Streams::IInterface::IInterface ( std::istream &  Source)

Member Function Documentation

◆ clear() [1/3]

void diskCache::Streams::IInterface::clear ( std::ios::iostate  State = std::ios::goodbit)
inline

◆ clear() [2/3]

void diskCache::Streams::IInterface::clear ( std::ios::iostate  = std::ios::goodbit)

◆ clear() [3/3]

void diskCache::Streams::IInterface::clear ( std::ios::iostate  = std::ios::goodbit)

◆ eof() [1/3]

bool diskCache::Streams::IInterface::eof ( ) const

◆ eof() [2/3]

bool diskCache::Streams::IInterface::eof ( ) const
inline

◆ eof() [3/3]

bool diskCache::Streams::IInterface::eof ( ) const

◆ Version() [1/3]

version_type diskCache::Streams::Interface::Version ( ) const
inherited

◆ Version() [2/3]

version_type diskCache::Streams::Interface::Version ( ) const
inherited

◆ Version() [3/3]

Interface::version_type diskCache::Streams::Interface::Version ( ) const
inlineinherited

◆ version() [1/3]

void diskCache::Streams::Interface::version ( version_type  Version)
protectedinherited

◆ version() [2/3]

void diskCache::Streams::Interface::version ( version_type  Version)
inlineprotectedinherited

◆ version() [3/3]

void diskCache::Streams::Interface::version ( version_type  Version)
protectedinherited

Member Data Documentation

◆ m_stream

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

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