---

lfc::File Class Reference

Inheritance diagram for lfc::File::

List of all members.

Public Types
enum	State { stOpen, stClosed }
enum	SeekMode { seekSet = pal::files::seekSet, seekCurrent = pal::files::seekCurrent, seekEnd = pal::files::seekEnd }
enum	OpenMode {   flAppend = pal::files::flAppend, flRead = pal::files::flRead, flWrite = pal::files::flWrite, flTruncate = pal::files::flTruncate,   flOpenExisting = pal::files::flOpenExisting, flCreateNew = pal::files::flCreateNew, flTemp = pal::files::flTemp }
enum	ShareMode { shRead = pal::files::shRead, shWrite = pal::files::shWrite }
Public Methods
	File () throw ()
	File (string filename, int flags=flRead, int shareFlags=0)
virtual	~File () throw ()
virtual char	pop ()
virtual void	resetInput ()
virtual bool	hasMore () const
virtual long	read (char *buffer, long count, bool bWaitAll=true)
virtual void	push (const char &value)
virtual void	resetOutput ()
virtual bool	acceptMore () const
virtual void	flush ()
virtual long	write (const char *buffer, long count, bool bWaitAll=true)
virtual void	open (string filename, int flags=flRead, int shareFlags=0)
virtual void	close ()
virtual long	seek (long offset, SeekMode mode=seekSet)
virtual long	position () const
virtual long	size () const
virtual void	setEof (long offset=-1)
virtual State	state () const throw ()
Protected Methods
virtual void	testState (State state, string location) const
Protected Attributes
pal::files::Handle	m_handle
State	m_state

---

Detailed Description

Todo:

document this!

make this thread safe

---

Member Enumeration Documentation

enum lfc::File::State

Enumeration values: stOpen  stClosed

enum lfc::File::SeekMode

Enumeration values: seekSet  seekCurrent  seekEnd

enum lfc::File::OpenMode

Enumeration values: flAppend  flRead  flWrite  flTruncate  flOpenExisting  flCreateNew  flTemp

enum lfc::File::ShareMode

Enumeration values: shRead  shWrite

---

Constructor & Destructor Documentation

lfc::File::File (    )  throw ()

lfc::File::File (  string    filename, int    flags = flRead, int    shareFlags = 0 )

lfc::File::~File (    )  throw () [virtual]

---

Member Function Documentation

char lfc::File::pop (    )  [virtual]

Reimplemented from lfc::_Input.

void lfc::File::resetInput (    )  [virtual]

Reimplemented from lfc::_Input.

bool lfc::File::hasMore (    )  const [virtual]

Reimplemented from lfc::_Input.

long lfc::File::read (  char *    buffer, long    count, bool    bWaitAll = true )  [virtual]

void lfc::File::push (  const char &    value )  [virtual]

void lfc::File::resetOutput (    )  [virtual]

Reimplemented from lfc::_Output.

bool lfc::File::acceptMore (    )  const [virtual]

Reimplemented from lfc::_Output.

void lfc::File::flush (    )  [virtual]

Reimplemented from lfc::_Output.

long lfc::File::write (  const char *    buffer, long    count, bool    bWaitAll = true )  [virtual]

void lfc::File::open (  string    filename, int    flags = flRead, int    shareFlags = 0 )  [virtual]

void lfc::File::close (    )  [virtual]

long lfc::File::seek (  long    offset, SeekMode    mode = seekSet )  [virtual]

long lfc::File::position (    )  const [virtual]

long lfc::File::size (    )  const [virtual]

void lfc::File::setEof (  long    offset = -1 )  [virtual]

virtual State lfc::File::state (    )  const throw () [inline, virtual]

virtual void lfc::File::testState (  State    state, string    location )  const [inline, protected, virtual]

---

Member Data Documentation

pal::files::Handle lfc::File::m_handle [protected]

State lfc::File::m_state [protected]

---

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

• lfc.streams.file
• file.cpp

---