base::CacheDirectory Class Reference

Inheritance diagram for base::CacheDirectory:

[legend]Collaboration diagram for base::CacheDirectory:

[legend]List of all members.

Public Types
typedef VEntryIterator	iterator
typedef VEntryIterator	const_iterator
Public Member Functions
virtual	~CacheDirectory ()
virtual String	className () const
virtual Object &	clone () const
virtual void	operator= (const CacheDirectory &d)
virtual bool	contains (ref< const VEntry > name) const
virtual bool	contains (const PathName &name) const
virtual ref< VFile >	file (const PathName &name) const throw (path_not_found)
	construct a new VFile object
virtual ref< VDirectory >	directory (const PathName &name) const throw (path_not_found)
	construct a new VDirectory object
virtual ref< VFile >	createFile (const PathName &name) const throw (io_error)
	create a new file in this directory
virtual void	deleteFile (const PathName &name) const throw (path_not_found, io_error)
	delete a file in this directory
virtual ref< VDirectory >	createDirectory (const PathName &name) const throw (io_error)
	create a new directory in this directory
virtual void	deleteDirectory (const PathName &name) const throw (path_not_found, io_error)
	delete a directory in this directory
virtual bool	isDirectory () const
virtual bool	empty () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
virtual bool	operator== (const VEntry &e) const
virtual const PathName	path () const
virtual const PathName	name () const
virtual const PathName	pathName () const
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Protected Types
typedef array< ref< CacheFile > >	CacheFileEntries
Protected Member Functions
ref< VEntry >	find (const String &name) const
void	load () const
virtual ref< VEntry >	entry (Int i) const
virtual Int	size () const
	CacheDirectory (const CacheDirectory &d)
	CacheDirectory (ref< VDirectory > actualDir, const String &prefix)
Protected Attributes
ref< VDirectory >	actualDir
String	prefix
bool	loaded
CacheFileEntries	entries
PathName	pathname
int	_refCount
bool	onUnreferenceEnabled
Friends
class	Cache
class	VFileSystem
class	VDirectory
class	VFile

---

Member Typedef Documentation

typedef array<ref<CacheFile> > base::CacheDirectory::CacheFileEntries [protected]

Definition at line 69 of file CacheDirectory.

typedef VEntryIterator base::VDirectory::const_iterator [inherited]

Definition at line 84 of file VDirectory.

typedef VEntryIterator base::VDirectory::iterator [inherited]

Definition at line 83 of file VDirectory.

---

Constructor & Destructor Documentation

virtual base::CacheDirectory::~CacheDirectory (   )  [virtual]

base::CacheDirectory::CacheDirectory (  const CacheDirectory &  d  )  [protected]

Referenced by clone().

base::CacheDirectory::CacheDirectory (  ref< VDirectory >  actualDir, const String &  prefix )  [protected]

---

Member Function Documentation

const_iterator base::VDirectory::begin (   )  const [inline, inherited]

Definition at line 87 of file VDirectory.

iterator base::VDirectory::begin (   )  [inline, inherited]

Definition at line 86 of file VDirectory.

virtual String base::CacheDirectory::className (   )  const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes. Reimplemented from base::VDirectory. Definition at line 43 of file CacheDirectory. References base::String. Referenced by clone().

virtual Object& base::CacheDirectory::clone (   )  const [inline, virtual]

Definition at line 44 of file CacheDirectory. References CacheDirectory(), className(), and NewNamedObj.

virtual bool base::CacheDirectory::contains (  const PathName &  name  )  const [virtual]

Implements base::VDirectory.

virtual bool base::CacheDirectory::contains (  ref< const VEntry >  name  )  const [virtual]

Implements base::VDirectory.

virtual ref<VDirectory> base::CacheDirectory::createDirectory (  const PathName &  name  )  const throw (io_error) [virtual]

create a new directory in this directory Implements base::VDirectory.

virtual ref<VFile> base::CacheDirectory::createFile (  const PathName &  name  )  const throw (io_error) [virtual]

create a new file in this directory Implements base::VDirectory.

virtual void base::CacheDirectory::deleteDirectory (  const PathName &  name  )  const throw (path_not_found, io_error) [virtual]

delete a directory in this directory Implements base::VDirectory.

virtual void base::CacheDirectory::deleteFile (  const PathName &  name  )  const throw (path_not_found, io_error) [virtual]

delete a file in this directory Implements base::VDirectory.

virtual ref<VDirectory> base::CacheDirectory::directory (  const PathName &  name  )  const throw (path_not_found) [virtual]

construct a new VDirectory object Implements base::VDirectory.

virtual bool base::VDirectory::empty (   )  const [inline, virtual, inherited]

Definition at line 50 of file VDirectory. References base::VDirectory::size().

void base::Referenced::enableOnUnreferenceCall (  bool  enabled  )  [inline, inherited]

If enabled, each call to unreference() will also call virtual method onUnreference() Definition at line 115 of file Referenced. References base::Referenced::onUnreferenceEnabled.

const_iterator base::VDirectory::end (   )  const [inline, inherited]

Definition at line 90 of file VDirectory. References base::VDirectory::size().

iterator base::VDirectory::end (   )  [inline, inherited]

Definition at line 89 of file VDirectory. References base::VDirectory::size().

virtual ref<VEntry> base::CacheDirectory::entry (  Int  i  )  const [protected, virtual]

Implements base::VDirectory.

virtual ref<VFile> base::CacheDirectory::file (  const PathName &  name  )  const throw (path_not_found) [virtual]

construct a new VFile object Implements base::VDirectory.

ref<VEntry> base::CacheDirectory::find (  const String &  name  )  const [protected]

virtual bool base::VDirectory::isDirectory (   )  const [inline, virtual, inherited]

Implements base::VEntry. Definition at line 46 of file VDirectory.

virtual bool base::Object::isSameKindAs (  const Object &   )  const [inline, virtual, inherited]

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs (  const ReferencedObject &   )  const [inline, virtual, inherited]

Definition at line 52 of file ReferencedObject.

void base::CacheDirectory::load (   )  const [protected]

virtual const PathName base::VEntry::name (   )  const [inline, virtual, inherited]

Definition at line 45 of file VEntry. References base::PathName::name(), and base::VEntry::pathname.

virtual void base::Referenced::onUnreference (   )  const [inline, virtual, inherited]

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface, and robot::control::ControllableAdaptor. Definition at line 121 of file Referenced. Referenced by base::Referenced::unreference().

virtual void base::CacheDirectory::operator= (  const CacheDirectory &  d  )  [virtual]

virtual bool base::VEntry::operator== (  const VEntry &  e  )  const [inline, virtual, inherited]

Definition at line 41 of file VEntry. References base::VEntry::pathname.

virtual const PathName base::VEntry::path (   )  const [inline, virtual, inherited]

Reimplemented in base::CacheFile. Definition at line 44 of file VEntry. References base::PathName::path(), and base::VEntry::pathname.

virtual const PathName base::VEntry::pathName (   )  const [inline, virtual, inherited]

Reimplemented in base::CacheFile. Definition at line 46 of file VEntry. References base::VEntry::pathname.

void base::Referenced::reference (   )  const [inline, inherited]

Increment the reference count by one, indicating that this object has another pointer which is referencing it. Definition at line 65 of file Referenced. References base::Referenced::_refCount.

const int base::Referenced::referenceCount (   )  const [inline, inherited]

Return the number pointers currently referencing this object. Definition at line 112 of file Referenced. References base::Referenced::_refCount. Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference().

virtual Int base::CacheDirectory::size (   )  const [protected, virtual]

Implements base::VDirectory.

bool base::Referenced::unreference (   )  const [inline, inherited]

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted. Definition at line 81 of file Referenced. References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.

---

Friends And Related Function Documentation

friend class Cache [friend]

Definition at line 75 of file CacheDirectory.

friend class VDirectory [friend, inherited]

Definition at line 56 of file VEntry.

friend class VFile [friend, inherited]

Definition at line 57 of file VEntry.

friend class VFileSystem [friend, inherited]

Reimplemented from base::VEntry. Definition at line 102 of file VDirectory.

---

Member Data Documentation

int base::Referenced::_refCount [mutable, protected, inherited]

Definition at line 136 of file Referenced. Referenced by base::Referenced::reference(), base::Referenced::referenceCount(), base::Referenced::Referenced(), base::Referenced::unreference(), and base::Referenced::~Referenced().

ref<VDirectory> base::CacheDirectory::actualDir [protected]

Definition at line 61 of file CacheDirectory.

CacheFileEntries base::CacheDirectory::entries [mutable, protected]

Definition at line 70 of file CacheDirectory.

bool base::CacheDirectory::loaded [mutable, protected]

Definition at line 68 of file CacheDirectory.

bool base::Referenced::onUnreferenceEnabled [protected, inherited]

Definition at line 137 of file Referenced. Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().

PathName base::VEntry::pathname [protected, inherited]

Definition at line 49 of file VEntry. Referenced by base::VEntry::name(), base::VEntry::operator=(), base::VEntry::operator==(), base::VEntry::path(), base::VEntry::pathName(), and base::VEntry::VEntry().

String base::CacheDirectory::prefix [protected]

Definition at line 62 of file CacheDirectory.

---

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

• base/CacheDirectory

---