ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Common::DumpFile Class Reference

TODO: document this class. More...

#include <file.h>

Inheritance diagram for Common::DumpFile:
Collaboration diagram for Common::DumpFile:

List of all members.

Public Member Functions

 DumpFile ()
virtual ~DumpFile ()
virtual bool open (const String &filename, bool createPath=false)
virtual bool open (const FSNode &node)
virtual void close ()
bool isOpen () const
 Checks if the object opened a file successfully.
bool err () const
void clearErr ()
virtual uint32 write (const void *dataPtr, uint32 dataSize) override
virtual bool flush () override
virtual int32 pos () const override
virtual bool seek (int32 offset, int whence=SEEK_SET) override
virtual int32 size () const override

Protected Attributes

WriteStream_handle
 File handle to the actual file; 0 if no file is open.

Detailed Description

TODO: document this class.

Some design ideas:

  • automatically drop all files into dumps/ dir? Might not be desired in all cases

Definition at line 137 of file file.h.


Constructor & Destructor Documentation

Common::DumpFile::DumpFile (  ) 

Definition at line 147 of file file.cpp.

Common::DumpFile::~DumpFile (  )  [virtual]

Definition at line 150 of file file.cpp.


Member Function Documentation

void Common::DumpFile::clearErr (  ) 

Definition at line 209 of file file.cpp.

void Common::DumpFile::close (  )  [virtual]

Definition at line 195 of file file.cpp.

bool Common::DumpFile::err (  )  const

Definition at line 204 of file file.cpp.

bool Common::DumpFile::flush (  )  [override, virtual]

Definition at line 219 of file file.cpp.

bool Common::DumpFile::isOpen (  )  const

Checks if the object opened a file successfully.

Returns:
: true if any file is opened, false otherwise.

Definition at line 200 of file file.cpp.

bool Common::DumpFile::open ( const FSNode node  )  [virtual]

Definition at line 179 of file file.cpp.

bool Common::DumpFile::open ( const String filename,
bool  createPath = false 
) [virtual]

Definition at line 154 of file file.cpp.

int32 Common::DumpFile::pos (  )  const [override, virtual]

Definition at line 224 of file file.cpp.

bool Common::DumpFile::seek ( int32  offset,
int  whence = SEEK_SET 
) [override, virtual]

Definition at line 226 of file file.cpp.

int32 Common::DumpFile::size (  )  const [override, virtual]

Definition at line 231 of file file.cpp.

uint32 Common::DumpFile::write ( const void *  dataPtr,
uint32  dataSize 
) [override, virtual]

Definition at line 214 of file file.cpp.


Member Data Documentation

File handle to the actual file; 0 if no file is open.

Definition at line 140 of file file.h.


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


Generated on Sat Dec 7 2019 05:02:11 for ResidualVM by doxygen 1.7.1
curved edge   curved edge