RageFile Class Reference

#include <RageFile.h>

Inheritance diagram for RageFile:

[legend]Collaboration diagram for RageFile:

[legend]List of all members.

Public Types
enum	{ READ = 0x1, WRITE = 0x2, STREAMED = 0x4, SLOW_FLUSH = 0x8 }
Public Member Functions
	RageFile ()
	~RageFile ()
	RageFile (const RageFile &cpy)
RageFileBasic *	Copy () const
const CString &	GetRealPath () const
CString	GetPath () const
bool	Open (const CString &path, int mode=READ)
void	Close ()
bool	IsOpen () const
bool	AtEOF () const
CString	GetError () const
void	ClearError ()
bool	IsGood () const
int	Tell () const
int	Seek (int offset)
int	GetFileSize () const
int	Read (void *buffer, size_t bytes)
int	Read (CString &buffer, int bytes=-1)
int	Write (const void *buffer, size_t bytes)
int	Write (const CString &string)
int	Flush ()
int	Write (const void *buffer, size_t bytes, int nmemb)
int	Read (void *buffer, size_t bytes, int nmemb)
int	Seek (int offset, int whence)
int	GetLine (CString &out)
int	PutLine (const CString &str)
void	EnableCRC32 (bool on=true)
bool	GetCRC32 (uint32_t *iRet)
Protected Member Functions
void	SetError (const CString &err)
Private Attributes
RageFileBasic *	m_File
CString	m_Path
CString	m_sError
int	m_Mode

---

Member Enumeration Documentation

anonymous enum

Enumeration values: READ  WRITE  STREAMED  SLOW_FLUSH

---

Constructor & Destructor Documentation

RageFile::RageFile (   )

RageFile::~RageFile (   )  [inline]

RageFile::RageFile (  const RageFile &  cpy  )

---

Member Function Documentation

bool RageFile::AtEOF (   )  const [virtual]

Implements RageFileBasic.

void RageFile::ClearError (   )  [virtual]

Implements RageFileBasic.

void RageFile::Close (   )

RageFileBasic * RageFile::Copy (   )  const [virtual]

Implements RageFileBasic.

void RageFile::EnableCRC32 (  bool  on = true  )  [virtual]

Implements RageFileBasic.

int RageFile::Flush (   )  [virtual]

Implements RageFileBasic.

bool RageFile::GetCRC32 (  uint32_t *  iRet  )  [virtual]

Implements RageFileBasic.

CString RageFile::GetError (   )  const [virtual]

Implements RageFileBasic.

int RageFile::GetFileSize (   )  const [virtual]

Implements RageFileBasic.

int RageFile::GetLine (  CString &  out  )  [virtual]

Implements RageFileBasic.

CString RageFile::GetPath (   )  const

const CString& RageFile::GetRealPath (   )  const [inline]

bool RageFile::IsGood (   )  const [inline]

bool RageFile::IsOpen (   )  const [inline]

bool RageFile::Open (  const CString &  path, int  mode = READ )

int RageFile::PutLine (  const CString &  str  )  [virtual]

Implements RageFileBasic.

int RageFile::Read (  void *  buffer, size_t  bytes, int  nmemb )  [virtual]

Implements RageFileBasic.

int RageFile::Read (  CString &  buffer, int  bytes = -1 )  [virtual]

Implements RageFileBasic.

int RageFile::Read (  void *  buffer, size_t  bytes )  [virtual]

Implements RageFileBasic.

int RageFile::Seek (  int  offset, int  whence )  [virtual]

Implements RageFileBasic.

int RageFile::Seek (  int  offset  )  [virtual]

Implements RageFileBasic.

void RageFile::SetError (  const CString &  err  )  [protected]

int RageFile::Tell (   )  const [virtual]

Implements RageFileBasic.

int RageFile::Write (  const void *  buffer, size_t  bytes, int  nmemb )  [virtual]

Implements RageFileBasic.

int RageFile::Write (  const CString &  string  )  [inline, virtual]

Implements RageFileBasic.

int RageFile::Write (  const void *  buffer, size_t  bytes )  [virtual]

Implements RageFileBasic.

---

Member Data Documentation

RageFileBasic* RageFile::m_File [private]

int RageFile::m_Mode [private]

CString RageFile::m_Path [private]

CString RageFile::m_sError [private]

---

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

• RageFile.h
• RageFile.cpp

---