Indexed file interface. More...

Inheritance diagram for IIndexedFile:

Public Types
enum	tTimeFormat { TF_ChunkIndex = 1 , TF_ChunkTime = 2 , TF_StreamIndex = 3 }
	Time format (for seek etc.) More...

enum	tReadFlags { RF_None = 0x0 , RF_UseExternalBuffer = 0x1 , RF_Backwards = 0x2 }
	Read options.

enum	tSeekFlags { SF_DEFAULT = 0x0 , SF_KEYDATA = 0x1 , SF_BEFORE = 0x02 }
	Seek flags. More...

enum	tChunkType { CT_DATA = 0x00 , CT_KEYDATA = 0x01 , CT_INFO = 0x02 , CT_MARKER = 0x04 , CT_TYPE = 0x08 , CT_TRIGGER = 0x10 }
	The chunk types. More...

enum	tOpenMode { OM_None = 0x00 , OM_DisableFileSystemCache = 0x01 , OM_SyncWrite = 0x02 , OM_QueryInfo = 0x04 , OM_ValidateChunkHeader = 0x08 , OM_FileChangeMode = 0x10 }
	File open modes. More...

Detailed Description

Indexed file interface.

Definition at line 17 of file indexedfile_types.h.

Member Enumeration Documentation

The chunk types.

Enumerator
CT_DATA	marks the chunk as data
CT_KEYDATA	marks the chunk as KEY data (results to an index table entry)
CT_INFO	marks the chunk as info data
CT_MARKER	marks the chunk as marker data
CT_TYPE	marks the chunk as type data
CT_TRIGGER	marks the chunk as trigger data

Definition at line 292 of file indexedfile_types.h.

File open modes.

Enumerator
OM_None	No Flag set.
OM_DisableFileSystemCache	This will disable the file system cache provided by operating system for any file operations. The disabling of file system cache results in a direct writing operation to the HD controller to ensure sector aligned writing etc. Only valid for writing operations.
OM_SyncWrite	This will disable the asynchronous internal cache. Any Write operation results in a direct file operation call. Only valid for writing operations.
OM_QueryInfo	Only valid for reading file operations. Will only open the extension table.
OM_ValidateChunkHeader	Only valid for writing file. An additional check of chunk validity is made! This Flag is available as performance reasons.
OM_FileChangeMode	Only valid for modify file operations.

Definition at line 311 of file indexedfile_types.h.

Seek flags.

Enumerator
SF_DEFAULT	The default seek flag.
SF_KEYDATA	Just seek in index table.
SF_BEFORE	Seek to the last chunk before the seek time.

Definition at line 279 of file indexedfile_types.h.

Time format (for seek etc.)

Enumerator

TF_ChunkIndex

The chunk at this index counter within the whole file.

The stream Id is ignored in this case.

TF_ChunkTime

The chunk with this timestamp within the stream which is specified by the stream Id.

TF_StreamIndex

The chunk at this index counter within the stream which is specified by the stream Id.

Definition at line 25 of file indexedfile_types.h.