base::VDirectory Class Reference

Inheritance diagram for base::VDirectory:

[legend]Collaboration diagram for base::VDirectory:

[legend]List of all members.


Public Types
typedef VEntryIterator	iterator
typedef VEntryIterator	const_iterator
Public Member Functions
virtual	~VDirectory ()
virtual String	className () const
virtual bool	isDirectory () const
virtual bool	contains (ref< const VEntry > entry) const=0
virtual bool	contains (const PathName &name) const=0
virtual bool	empty () const
virtual ref< VFile >	file (const PathName &name) const=0 throw (path_not_found)
	construct a new VFile object
virtual ref< VDirectory >	directory (const PathName &name) const=0 throw (path_not_found)
	construct a new VDirectory object
virtual ref< VFile >	createFile (const PathName &name) const=0 throw (io_error)
	create a new file in this directory
virtual void	deleteFile (const PathName &name) const=0 throw (path_not_found, io_error)
	delete a file in this directory
virtual ref< VDirectory >	createDirectory (const PathName &name) const=0 throw (io_error)
	create a new directory in this directory
virtual void	deleteDirectory (const PathName &name) const=0 throw (path_not_found, io_error)
	delete a directory in this directory
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 Member Functions
virtual ref< VEntry >	entry (Int i) const=0
virtual Int	size () const=0
	VDirectory ()
	VDirectory (const PathName &pathname) throw (std::invalid_argument)
	VDirectory (const VDirectory &d)
VDirectory &	operator= (const VDirectory &d)
Protected Attributes
PathName	pathname
int	_refCount
bool	onUnreferenceEnabled
Friends
class	VFileSystem
class	VDirectory
class	VFile

Member Typedef Documentation

typedef VEntryIterator base::VDirectory::const_iterator

Definition at line 84 of file VDirectory.

typedef VEntryIterator base::VDirectory::iterator

Definition at line 83 of file VDirectory.

Constructor & Destructor Documentation

virtual base::VDirectory::~VDirectory ( ) [inline, virtual]

Definition at line 42 of file VDirectory.

base::VDirectory::VDirectory ( ) [inline, protected]

Definition at line 97 of file VDirectory.

base::VDirectory::VDirectory ( const PathName & pathname ) throw (std::invalid_argument) [inline, protected]

Definition at line 98 of file VDirectory.

base::VDirectory::VDirectory ( const VDirectory & d ) [inline, protected]

Definition at line 99 of file VDirectory.

Member Function Documentation

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

Definition at line 87 of file VDirectory.

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

Definition at line 86 of file VDirectory.

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

return the name of the object's class type. Must be defined by derived classes.
Implements base::Object.
Reimplemented in base::CacheDirectory, and base::Directory.
Definition at line 44 of file VDirectory.
References base::String.

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

Implemented in base::CacheDirectory, and base::Directory.

virtual bool base::VDirectory::contains ( ref< const VEntry > entry ) const [pure virtual]

Implemented in base::CacheDirectory, and base::Directory.

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

create a new directory in this directory

Implemented in base::CacheDirectory, and base::Directory.

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

create a new file in this directory

Implemented in base::CacheDirectory, and base::Directory.

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

delete a directory in this directory

Implemented in base::CacheDirectory, and base::Directory.

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

delete a file in this directory

Implemented in base::CacheDirectory, and base::Directory.

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

construct a new VDirectory object

Implemented in base::CacheDirectory, and base::Directory.

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

Definition at line 50 of file VDirectory.
References 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]

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

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

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

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

Implemented in base::CacheDirectory, and base::Directory.

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

construct a new VFile object

Implemented in base::CacheDirectory, and base::Directory.

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

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.

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().

VDirectory& base::VDirectory::operator= ( const VDirectory & d ) [inline, protected]

Definition at line 100 of file VDirectory.

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::VDirectory::size ( ) const [protected, pure virtual]

Implemented in base::CacheDirectory, and base::Directory.
Referenced by empty(), and end().

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.