FileStreamObject Class Reference

#include <fileStreamObject.h>

Inheritance diagram for FileStreamObject:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 FileStreamObject ()
virtual ~FileStreamObject ()
 DECLARE_CONOBJECT (FileStreamObject)
virtual bool onAdd ()
 Called when the object is added to the sim.
bool open (const char *filename, Torque::FS::File::AccessMode mode)
 Open a file.
void close ()
 Close the file.

Protected Attributes

FileStream mFileStream

Private Types

typedef StreamObject Parent

Member Typedef Documentation

Reimplemented from StreamObject.


Constructor & Destructor Documentation

FileStreamObject::FileStreamObject (  ) 

virtual FileStreamObject::~FileStreamObject (  )  [virtual]


Member Function Documentation

FileStreamObject::DECLARE_CONOBJECT ( FileStreamObject   ) 

virtual bool FileStreamObject::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from StreamObject.

bool FileStreamObject::open ( const char *  filename,
Torque::FS::File::AccessMode  mode 
)

Open a file.

Parameters:
filename Name of file to open
mode One of Torque::FS::File::Read, Torque::FS::File::Write, Torque::FS::File::ReadWrite or Torque::FS::File::WriteAppend
Returns:
true for success, false for failure
See also:
close()

void FileStreamObject::close (  ) 

Close the file.

See also:
open()


Member Data Documentation