DirectoryArchiveFile Class Reference

An ArchiveFile which is stored as a single file on disk. More...

#include <archivelib.h>

Inheritance diagram for DirectoryArchiveFile:

[legend]

Collaboration diagram for DirectoryArchiveFile:

[legend]

Public Types
typedef FileInputStream::size_type	size_type
Public Member Functions
	DirectoryArchiveFile (const std::string &name, const std::string &filename)
bool	failed () const
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.
Private Attributes
std::string	m_name
FileInputStream	m_istream
FileInputStream::size_type	m_size

---

Detailed Description

An ArchiveFile which is stored as a single file on disk.

Definition at line 175 of file archivelib.h.

---

Member Typedef Documentation

typedef FileInputStream::size_type DirectoryArchiveFile::size_type

Definition at line 181 of file archivelib.h.

---

Constructor & Destructor Documentation

DirectoryArchiveFile::DirectoryArchiveFile	(	const std::string &	name,
		const std::string &	filename
	)			[inline]

Definition at line 183 of file archivelib.h.

References failed(), m_istream, and m_size.

---

Member Function Documentation

bool DirectoryArchiveFile::failed

(

)

const [inline]

Definition at line 194 of file archivelib.h.

References m_istream.

Referenced by DirectoryArchiveFile().

InputStream& DirectoryArchiveFile::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 207 of file archivelib.h.

References m_istream.

const std::string DirectoryArchiveFile::getName

(

)

const [inline, virtual]

Returns the path to this file (relative to the filesystem root).

Implements ArchiveFile.

Definition at line 203 of file archivelib.h.

References m_name.

size_type DirectoryArchiveFile::size

(

)

const [inline, virtual]

Returns the size of the file data in bytes.

Implements ArchiveFile.

Definition at line 199 of file archivelib.h.

References m_size.

---

Field Documentation

FileInputStream DirectoryArchiveFile::m_istream [private]

Definition at line 178 of file archivelib.h.

Referenced by DirectoryArchiveFile(), failed(), and getInputStream().

std::string DirectoryArchiveFile::m_name [private]

Definition at line 177 of file archivelib.h.

Referenced by getName().

FileInputStream::size_type DirectoryArchiveFile::m_size [private]

Definition at line 179 of file archivelib.h.

Referenced by DirectoryArchiveFile(), and size().

---

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

• src/tools/radiant/libs/archivelib.h