AaronCameron.net
There have to be easier ways to commit suicide.
Not a Member? - Login or Create an Account...MC Offline
Wednesday the 22nd of May 2013 @ 05:53pm
Front Page Journal Projects Your Profile About
[]

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cVfsDirectoryInterface Class Reference

A description of the interface necessary to implement a listing of virtual file system nodes as well as providing a handle for any listing of nodes, regardless of their location or storage. More...

#include <cVfsDirectoryInterface.h>

Inheritance diagram for n2l::cVfsDirectoryInterface:

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

Collaboration graph
[legend]
List of all members.

Public Types

Public Member Functions

Protected Types

Protected Member Functions


Detailed Description

A description of the interface necessary to implement a listing of virtual file system nodes as well as providing a handle for any listing of nodes, regardless of their location or storage.

Definition at line 44 of file cVfsDirectoryInterface.h.


Member Typedef Documentation

typedef tContainer::const_iterator n2l::cVfsDirectoryInterface::tConstIterator
 

Definition at line 55 of file cVfsDirectoryInterface.h.

typedef std::map<const tKey,cAutoPtr<const tValue> > n2l::cVfsDirectoryInterface::tContainer [protected]
 

Definition at line 52 of file cVfsDirectoryInterface.h.

typedef tString n2l::cVfsDirectoryInterface::tKey
 

Definition at line 48 of file cVfsDirectoryInterface.h.

typedef tUint n2l::cVfsDirectoryInterface::tSize
 

Definition at line 47 of file cVfsDirectoryInterface.h.

typedef cVfsNodeInterface n2l::cVfsDirectoryInterface::tValue
 

Definition at line 49 of file cVfsDirectoryInterface.h.


Constructor & Destructor Documentation

n2l::cVfsDirectoryInterface::~cVfsDirectoryInterface  )  [virtual]
 

Definition at line 41 of file cVfsDirectoryInterface.cpp.

n2l::cVfsDirectoryInterface::cVfsDirectoryInterface  )  [protected]
 

Definition at line 35 of file cVfsDirectoryInterface.cpp.


Member Function Documentation

virtual const tConstIterator n2l::cVfsDirectoryInterface::begin  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory.

Referenced by dump().

virtual void n2l::cVfsDirectoryInterface::copyNode const tConstIterator iNodeI,
const tVfsNodeName iNewName,
const cVfsDirectoryInterface oDir
const [pure virtual]
 

const tString n2l::cVfsDirectoryInterface::dump  )  const [virtual]
 

Definition at line 94 of file cVfsDirectoryInterface.cpp.

References begin(), end(), n2l::cVfsNodeInterface::name(), and n2l::vfsPermissionsAsString().

virtual const tBool n2l::cVfsDirectoryInterface::empty  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory.

virtual const tConstIterator n2l::cVfsDirectoryInterface::end  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory.

Referenced by n2l::cVfsDirectory::copyNode(), dump(), and findUniqueName().

virtual const tConstIterator n2l::cVfsDirectoryInterface::find const tKey iName  )  const [pure virtual]
 

Referenced by n2l::cVfsDirectory::copyNode(), and findUniqueName().

const tVfsNodeName n2l::cVfsDirectoryInterface::findUniqueName const tVfsNodeName iPrefix  )  const [virtual]
 

Return a vfsname based on iPrefix which doesn't already exist in this directory.

Ideal for copying files to a directory without checking if a duplicate file already exists.

Warning:
: This method shouldn't be used for generating temporary files because the name is entirely predictable.

: This method has absolutely no respect for the extension of a file, and will happily destroy it.

Definition at line 71 of file cVfsDirectoryInterface.cpp.

References n2l::asString(), n2l::cleanVfsPath(), n2l::cString::empty(), end(), find(), n2l::cString::findFirstOf(), _n2l::FsPathSeperatorSymbol, n2l::cString::npos, and n2l::VfsPathSeperatorSymbol.

virtual const tBool n2l::cVfsDirectoryInterface::hasChild const tKey iName  )  const [pure virtual]
 

const tBool n2l::cVfsDirectoryInterface::isDirectory  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 59 of file cVfsDirectoryInterface.cpp.

const tBool n2l::cVfsDirectoryInterface::isFile  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 65 of file cVfsDirectoryInterface.cpp.

Referenced by n2l::cVfsDirectory::unlinkNode().

const tBool n2l::cVfsDirectoryInterface::likeDirectory  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 47 of file cVfsDirectoryInterface.cpp.

const tBool n2l::cVfsDirectoryInterface::likeFile  )  const [virtual]
 

Implements n2l::cVfsNodeInterface.

Definition at line 53 of file cVfsDirectoryInterface.cpp.

virtual const cAutoPtr<const tValue>& n2l::cVfsDirectoryInterface::mustFind const tKey iName  )  const [pure virtual]
 

virtual const cAutoPtr<const tValue> n2l::cVfsDirectoryInterface::newDirectoryNode const tVfsNodeName iName  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory.

virtual const cAutoPtr<const tValue> n2l::cVfsDirectoryInterface::newFileNode const tVfsNodeName iName  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory.

Referenced by n2l::cVfsDirectory::copyNode().

virtual void n2l::cVfsDirectoryInterface::unlinkNode const tConstIterator iNodeI  )  const [pure virtual]
 

Erase the node provided by the iterator.

Directory nodes will be removed if empty, if not empty a vfsException will be thrown.

Referenced by n2l::cVfsDirectory::copyNode().


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