StoredArchiveFile Class Reference
An ArchiveFile which is stored uncompressed as part of a larger archive file. More...
#include <archivelib.h>
Public Types | |
| typedef FileInputStream::size_type | size_type |
| typedef FileInputStream::position_type | position_type |
Public Member Functions | |
| StoredArchiveFile (const std::string &name, const std::string &archiveName, position_type position, size_type stream_size, size_type file_size) | |
| size_type | size () const |
| Returns the size of the file data in bytes. | |
| const std::string | getName () const |
| Returns the path to this file (relative to the filesystem root). | |
| InputStream & | getInputStream () |
| Returns the stream associated with this file. Subsequent calls return the same stream. The stream may be read forwards until it is exhausted. The stream remains valid for the lifetime of the file. | |
Static Public Member Functions | |
| static StoredArchiveFile * | create (const char *name, const char *archiveName, position_type position, size_type stream_size, size_type file_size) |
Private Attributes | |
| std::string | m_name |
| FileInputStream | m_filestream |
| SubFileInputStream | m_substream |
| FileInputStream::size_type | m_size |
Detailed Description
An ArchiveFile which is stored uncompressed as part of a larger archive file.
Definition at line 101 of file archivelib.h.
Member Typedef Documentation
| typedef FileInputStream::position_type StoredArchiveFile::position_type |
Definition at line 109 of file archivelib.h.
| typedef FileInputStream::size_type StoredArchiveFile::size_type |
Definition at line 108 of file archivelib.h.
Constructor & Destructor Documentation
| StoredArchiveFile::StoredArchiveFile | ( | const std::string & | name, | |
| const std::string & | archiveName, | |||
| position_type | position, | |||
| size_type | stream_size, | |||
| size_type | file_size | |||
| ) | [inline] |
Definition at line 111 of file archivelib.h.
Member Function Documentation
| static StoredArchiveFile* StoredArchiveFile::create | ( | const char * | name, | |
| const char * | archiveName, | |||
| position_type | position, | |||
| size_type | stream_size, | |||
| size_type | file_size | |||
| ) | [inline, static] |
Definition at line 118 of file archivelib.h.
| InputStream& StoredArchiveFile::getInputStream | ( | ) | [inline, virtual] |
Returns the stream associated with this file. Subsequent calls return the same stream. The stream may be read forwards until it is exhausted. The stream remains valid for the lifetime of the file.
Implements ArchiveFile.
Definition at line 132 of file archivelib.h.
References m_substream.
| const std::string StoredArchiveFile::getName | ( | ) | const [inline, virtual] |
Returns the path to this file (relative to the filesystem root).
Implements ArchiveFile.
Definition at line 128 of file archivelib.h.
References m_name.
| size_type StoredArchiveFile::size | ( | ) | const [inline, virtual] |
Returns the size of the file data in bytes.
Implements ArchiveFile.
Definition at line 124 of file archivelib.h.
References m_size.
Field Documentation
FileInputStream StoredArchiveFile::m_filestream [private] |
Definition at line 104 of file archivelib.h.
std::string StoredArchiveFile::m_name [private] |
Definition at line 103 of file archivelib.h.
Referenced by getName().
FileInputStream::size_type StoredArchiveFile::m_size [private] |
Definition at line 106 of file archivelib.h.
Referenced by size().
SubFileInputStream StoredArchiveFile::m_substream [private] |
Definition at line 105 of file archivelib.h.
Referenced by getInputStream().
The documentation for this class was generated from the following file:
- src/tools/radiant/libs/archivelib.h
