This is the documentation for Enlighten.
class Geo IffReader
class Geo::IffReader
An IffReader allows you to use an IGeoStream to read Iff format binary files easily.
It is passed an IGeoStream in its constructor and also implements IGeoStream, thus making it like an Adaptor pattern. Although the class uses the function name 'BeginFile' the underlying stream can be of any type.
Functions
Name | Description |
|---|---|
Deleting a stream should behave like a close operation. | |
Step into the main FORM chunk, extract the file type tag. | |
Put the reader directly into a fail state. | |
Return the size of the current chunk. | |
Return the file type tag that was stored in IffReader::BeginFile() | |
Return the file version code that was stored in IffReader::BeginFile() | |
The method of reading Iff files is to iterate over the chunks by calling 'GetNextChunk' until the function returns Iff::EOFTag. | |
Wrap the IGeoStream::GetPosition function. | |
Return the position of the read/write pointer within the stream (prototype matches ftell) | |
Construct an IffReader with a pre-existing IGeoStream. | |
Wrap the IGeoStream::IsEof function. | |
Is the read pointer at the end of the file (as with feof, only returns true if you have read past end) | |
Wrap the IGeoStream::IsOk function, returning status of the IffWriter also. | |
Tests if the stream is valid. | |
Return status of the reader Note: Prefer to use the IGeoStream::IsOk() method. | |
Read data (prototype matches fread). Prefer to use the templated Read methods. | |
Wrap the IGeoStream::Read function, tracking the return code. | |
Read a single object, returning true on success. | |
Read a collection of objects, returning true on success. | |
Read a fixed size array. | |
Read a single object, returning true on success. | |
Read a single object, returning true on success. | |
Reads the stream to its end and returns the data as a char array. | |
Wrap the IGeoStream::SetPosition function, be careful when jumping around inside IffReader. | |
Set the position of the read/write pointer within the stream (prototype matches fseek) |
virtual Geo::IGeoInputStream::~IGeoInputStream
public: virtual ~IGeoInputStream()
Deleting a stream should behave like a close operation.
bool Geo::IffReader::BeginFile
public: bool BeginFile()