BufferIOFileClass Class Reference

#include <bfiofile.h>

Inherits RawFileClass.

Public Types
enum	{ MINIMUM_BUFFER_SIZE =1024 }
Public Types inherited from FileClass
enum	{ READ = 1 , WRITE = 2 , PRINTF_BUFFER_SIZE = 1024 }
enum	{ READ = 1 , WRITE = 2 , PRINTF_BUFFER_SIZE = 1024 }

Public Member Functions
	BufferIOFileClass (char const *filename)
	BufferIOFileClass (void)
virtual	~BufferIOFileClass (void)
bool	Cache (long size=0, void *ptr=NULL)
void	Free (void)
bool	Commit (void)
virtual char const *	Set_Name (char const *filename)
virtual bool	Is_Available (int forced=false)
virtual bool	Is_Open (void) const
virtual int	Open (char const *filename, int rights=READ)
virtual int	Open (int rights=READ)
virtual int	Read (void *buffer, int size)
virtual int	Seek (int pos, int dir=SEEK_CUR)
virtual int	Size (void)
virtual int	Write (void const *buffer, int size)
virtual void	Close (void)
Public Member Functions inherited from RawFileClass
	RawFileClass (char const *filename)
	RawFileClass (void)
	RawFileClass (RawFileClass const &f)
RawFileClass &	operator= (RawFileClass const &f)
virtual	~RawFileClass (void)
virtual char const *	File_Name (void) const
virtual int	Create (void)
virtual int	Delete (void)
virtual unsigned long	Get_Date_Time (void)
virtual bool	Set_Date_Time (unsigned long datetime)
virtual void	Error (int error, int canretry=false, char const *filename=NULL)
virtual void	Bias (int start, int length=-1)
virtual void *	Get_File_Handle (void)
virtual void	Attach (void *handle, int rights=READ)
virtual void	Detach (void)
	RawFileClass (char const *filename)
	RawFileClass (void)
	RawFileClass (RawFileClass const &f)
RawFileClass &	operator= (RawFileClass const &f)
virtual	~RawFileClass (void)
virtual char const *	File_Name (void) const
virtual int	Create (void)
virtual int	Delete (void)
virtual unsigned long	Get_Date_Time (void)
virtual bool	Set_Date_Time (unsigned long datetime)
virtual void	Error (int error, int canretry=false, char const *filename=NULL)
void	Bias (int start, int length=-1)
virtual void *	Get_File_Handle (void)
virtual void	Attach (void *handle, int rights=READ)
virtual void	Detach (void)
Public Member Functions inherited from FileClass
virtual	~FileClass (void)
virtual int	Tell (void)
	operator char const * ()
int	Printf (char *str,...)
int	Printf (char *buffer, int bufferSize, char *str,...)
int	Printf_Indented (unsigned depth, char *str,...)
virtual	~FileClass (void)
virtual int	Tell (void)
	operator char const * ()
int	Printf (char *str,...)
int	Printf (char *buffer, int bufferSize, char *str,...)
int	Printf_Indented (unsigned depth, char *str,...)

Additional Inherited Members
Public Attributes inherited from RawFileClass
int	Rights
int	BiasStart
int	BiasLength
Protected Member Functions inherited from RawFileClass
int	Transfer_Block_Size (void)
int	Raw_Seek (int pos, int dir=SEEK_CUR)
void	Reset (void)
int	Transfer_Block_Size (void)
int	Raw_Seek (int pos, int dir=SEEK_CUR)
void	Reset (void)

Detailed Description

Definition at line 47 of file bfiofile.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MINIMUM_BUFFER_SIZE

Definition at line 71 of file bfiofile.h.

Constructor & Destructor Documentation

BufferIOFileClass() [1/2]

BufferIOFileClass::BufferIOFileClass

(

char const *

filename

)

Definition at line 75 of file bfiofile.cpp.

BufferIOFileClass() [2/2]

BufferIOFileClass::BufferIOFileClass

(

void

)

Definition at line 111 of file bfiofile.cpp.

~BufferIOFileClass()

BufferIOFileClass::~BufferIOFileClass ( void )

virtual

Definition at line 146 of file bfiofile.cpp.

Member Function Documentation

Cache()

bool BufferIOFileClass::Cache	(	long	size = 0,
		void *	ptr = NULL )

Definition at line 165 of file bfiofile.cpp.

Close()

void BufferIOFileClass::Close ( void )

virtual

Reimplemented from RawFileClass.

Definition at line 961 of file bfiofile.cpp.

Commit()

bool BufferIOFileClass::Commit

(

void

)

Definition at line 361 of file bfiofile.cpp.

Free()

void BufferIOFileClass::Free

(

void

)

Definition at line 328 of file bfiofile.cpp.

Is_Available()

bool BufferIOFileClass::Is_Available ( int forced = false )

virtual

Reimplemented from RawFileClass.

Definition at line 439 of file bfiofile.cpp.

Is_Open()

bool BufferIOFileClass::Is_Open ( void ) const

virtual

Reimplemented from RawFileClass.

Definition at line 464 of file bfiofile.cpp.

Open() [1/2]

int BufferIOFileClass::Open ( char const * filename, int rights = READ )

virtual

Reimplemented from RawFileClass.

Definition at line 495 of file bfiofile.cpp.

Open() [2/2]

int BufferIOFileClass::Open ( int rights = READ )

virtual

Reimplemented from RawFileClass.

Definition at line 520 of file bfiofile.cpp.

Read()

int BufferIOFileClass::Read ( void * buffer, int size )

virtual

Reimplemented from RawFileClass.

Definition at line 728 of file bfiofile.cpp.

Seek()

int BufferIOFileClass::Seek ( int pos, int dir = SEEK_CUR )

virtual

Reimplemented from RawFileClass.

Definition at line 852 of file bfiofile.cpp.

Set_Name()

char const * BufferIOFileClass::Set_Name ( char const * filename )

virtual

Reimplemented from RawFileClass.

Definition at line 410 of file bfiofile.cpp.

Size()

int BufferIOFileClass::Size ( void )

virtual

Reimplemented from RawFileClass.

Definition at line 936 of file bfiofile.cpp.

Write()

int BufferIOFileClass::Write ( void const * buffer, int size )

virtual

Reimplemented from RawFileClass.

Definition at line 585 of file bfiofile.cpp.

---

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

• Code/Libraries/Source/WWVegas/WWLib/bfiofile.h
• Code/Libraries/Source/WWVegas/WWLib/bfiofile.cpp