Xface Core Library: XFace::FAPFile Class Reference

XFace / XEngine / XMath

previous page next page
XFace::FAPFile

XFace::FAPFile Class Reference
[XFace]

#include <FapFile.h>

Inheritance diagram for XFace::FAPFile:

XFace::IFapStream List of all members.

Detailed Description

Author:
Koray Balci
Version:
1.0
Date:
June 2003
This class accesses the contents of a FAP file from a disk and using the base class interface (IFapStream) provides FAP data to its clients.


Public Member Functions

bool isEnd () const
 query open
bool isOpen () const
 query open
void next ()
void rewind ()
bool open (std::istream &input, const FAPU &fapu)
 open/read the stream
virtual size_t getFAPCount () const
 Retrieves FAP count.

Static Public Member Functions

static bool save (IFapStream &faps, const FAPU &fapu, const std::string &filename)
 Saves fap stream to disk.

Member Function Documentation

void XFace::FAPFile::next (   )  [virtual]
 

Advances the current FAP to the next one. If we are at the end of the stream, pointer to current FAP is set to 0, so getCurrentFAP() call following it will return 0. So this code is legal (althoug it does nothing but goes to the end of the fap stream only); 

        while(pFAPs->getCurrentFAP())
        {
                pFAPs->next();
        };

Implements XFace::IFapStream.

void XFace::FAPFile::rewind (   )  [virtual]
 

Rewinds the stream to the first FAP in the stream.

Implements XFace::IFapStream.

bool XFace::FAPFile::save (  IFapStream &  faps,
const FAPU &  fapu,
const std::string &  filename
)  [static]
 

Saves a FAP stream to disk.

The documentation for this class was generated from the following files:
Generated on Mon Aug 28 15:39:26 2006 for Xface Core Library by  doxygen 1.4.6-NO

previous page start next page