All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FS_Writer Class Reference

Class for writing files. More...

#include <FS_Writer.h>

+ Inheritance diagram for FS_Writer:

Public Member Functions

 FS_Writer (const char *dest)
virtual ~FS_Writer ()
virtual int64 getMemoryUsage (bool inclusive) const
 Get the amount of memory owned by this FS_Writer. More...
void close ()
std::ostream * getStream () const
bool removeFile ()

Static Public Member Functions

static void addWriterHelper (FS_WriterHelper *helper)
static void removeWriterHelper (FS_WriterHelper *helper)

Detailed Description

Class for writing files.

Definition at line 25 of file FS_Writer.h.

Constructor & Destructor Documentation

FS_Writer::FS_Writer ( const char *  dest)

Use this constructor to create a new writer. The specified file is created immediately.

virtual FS_Writer::~FS_Writer ( )

Member Function Documentation

static void FS_Writer::addWriterHelper ( FS_WriterHelper helper)
void FS_Writer::close ( )

Closes the stream. After calling this function, the getStream() function will always return NULL.

virtual int64 FS_Writer::getMemoryUsage ( bool  inclusive) const

Get the amount of memory owned by this FS_Writer.

std::ostream* FS_Writer::getStream ( ) const

This function retrieves the C++ stream object which you can interact with in the normal ways. If this function returns NULL, the file specified in the constructor could not be created.

bool FS_Writer::removeFile ( )
static void FS_Writer::removeWriterHelper ( FS_WriterHelper helper)

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