AaronCameron.net
I care not for your petty politics.
Not a Member? - Login or Create an Account
Sunday the 5th of February 2012 @ 04:46pm
Front Page Journal Projects Your Profile About
[]

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cVfsFile Class Reference

An implementation of cVfsFileInterface which provides access to files located directly on the physical file system. More...

#include <cVfsFile.h>

Inheritance diagram for n2l::cVfsFile:

Inheritance graph
[legend]
Collaboration diagram for n2l::cVfsFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions


Detailed Description

An implementation of cVfsFileInterface which provides access to files located directly on the physical file system.

Definition at line 41 of file cVfsFile.h.


Constructor & Destructor Documentation

n2l::cVfsFile::cVfsFile const tFsNodeName iName  ) 
 

Definition at line 47 of file cVfsFile.cpp.

References n2l::convertFsLiteralNameToVfs(), n2l::cVfsStat::isFile(), and n2l::splitVfsPathBlocks().

n2l::cVfsFile::~cVfsFile  )  [virtual]
 

Definition at line 69 of file cVfsFile.cpp.


Member Function Documentation

void n2l::cVfsFile::buffer const tVfsFileBuffer iBuffer  )  const [virtual]
 

Overwrite the entire destination node with the information within 'iBuffer'.

Implements n2l::cVfsNodeInterface.

Definition at line 107 of file cVfsFile.cpp.

References n2l::cString::clear(), and n2l::cVfsStat::writeable().

const tVfsFileBuffer & n2l::cVfsFile::buffer  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 100 of file cVfsFile.cpp.

Referenced by getRWops().

void n2l::cVfsFile::clearCache  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 242 of file cVfsFile.cpp.

const tVfsFileBuffer & n2l::cVfsFile::firstLine  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 132 of file cVfsFile.cpp.

const tFsNodeName n2l::cVfsFile::fsName  )  const [virtual]
 

If supported, a real file system path is returned.

Implements n2l::cVfsNodeInterface.

Definition at line 236 of file cVfsFile.cpp.

void n2l::cVfsFile::getBuffer tVfsFileBuffer oBuffer  )  const [virtual]
 

Get a vfs buffer from this node.

Unlike the returning buffer() command, this method sets the provided argument to the buffer, and does not set the cache. This avoids caching, and passing by value.

Implements n2l::cVfsNodeInterface.

Definition at line 125 of file cVfsFile.cpp.

References n2l::getFsNodeDump().

SDL_RWops * n2l::cVfsFile::getRWops  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 140 of file cVfsFile.cpp.

References buffer(), n2l::cString::data(), and n2l::cString::size().

const tBool n2l::cVfsFile::isSymLink  )  const [virtual]
 

Definition at line 88 of file cVfsFile.cpp.

References n2l::cVfsStat::isSymLink().

const tVfsNodeName & n2l::cVfsFile::name  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 75 of file cVfsFile.cpp.

const tUint n2l::cVfsFile::permissions  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 82 of file cVfsFile.cpp.

References n2l::cVfsStat::permissions().

const tFsNodeName n2l::cVfsFile::readLink  )  const [virtual]
 

Definition at line 94 of file cVfsFile.cpp.

References n2l::cVfsStat::readLink().

const tUint n2l::cVfsFile::size  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 147 of file cVfsFile.cpp.

References n2l::getFsNodeSize().

const tBool n2l::cVfsFile::supportsFsName  )  const [virtual]
 

Return wheither this node may be accessed directly on the file system, or if it must be accessed via a file buffer.

Returns:
True if file system pathing is supported

Implements n2l::cVfsNodeInterface.

Definition at line 229 of file cVfsFile.cpp.


The documentation for this class was generated from the following files:
©2012 Aaron Cameron