Cafu Engine
cf::FileSys::LocalOutFileT Class Reference
Inheritance diagram for cf::FileSys::LocalOutFileT:

Public Member Functions

 LocalOutFileT (const std::string &BaseName_, const std::string &FullName_)
 Constructor. More...
 
bool IsOpen () const
 Returns whether the file has successfully been opened and is still open. More...
 
const std::string & GetBaseName () const
 Returns the base name of this file. The base name is relative to and agnostic of the file system this file is in. More...
 
const std::string & GetFullName () const
 Returns the full name of this file. More...
 
uint64_t GetPos () const
 Returns the current read/write position in the file. More...
 
bool Seek (int32_t Offset, SeekFromT SeekFrom)
 Modifies the position of the read/write pointer in the file. More...
 
void Write (const char *Buffer, uint32_t Size)
 Writes the contents of Buffer, which has size Size, into the file. More...
 
- Public Member Functions inherited from cf::FileSys::FileI
virtual ~FileI ()
 The virtual destructor, so that derived classes can safely be deleted via a FileI (base class) pointer. More...
 

Additional Inherited Members

- Public Types inherited from cf::FileSys::FileI
enum  SeekFromT { FROM_BEGINNING, FROM_CURRENT_POS, FROM_END }
 The values of this enumeration define from where the seek operation applies the offset. More...
 

Constructor & Destructor Documentation

LocalOutFileT::LocalOutFileT ( const std::string &  BaseName_,
const std::string &  FullName_ 
)

Constructor.

Member Function Documentation

const std::string & LocalOutFileT::GetBaseName ( ) const
virtual

Returns the base name of this file. The base name is relative to and agnostic of the file system this file is in.

Implements cf::FileSys::FileI.

const std::string & LocalOutFileT::GetFullName ( ) const
virtual

Returns the full name of this file.

The full name is the base name prepended by the file system specific path/URL. TODO: Have a GetFileSys() method instead???

Implements cf::FileSys::FileI.

uint64_t LocalOutFileT::GetPos ( ) const
virtual

Returns the current read/write position in the file.

Implements cf::FileSys::FileI.

bool LocalOutFileT::IsOpen ( ) const
virtual

Returns whether the file has successfully been opened and is still open.

Implements cf::FileSys::FileI.

bool LocalOutFileT::Seek ( int32_t  Offset,
SeekFromT  SeekFrom 
)
virtual

Modifies the position of the read/write pointer in the file.

Parameters
OffsetHow much to move the pointer.
SeekFromDefines from where the offset is applied, see SeekFromT for possible values.
Returns
true if the seek operation was successful, false otherwise.

Implements cf::FileSys::FileI.

void LocalOutFileT::Write ( const char *  Buffer,
uint32_t  Size 
)
virtual

Writes the contents of Buffer, which has size Size, into the file.

Implements cf::FileSys::OutFileI.


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