base::StdFileSystem Class Reference

Inheritance diagram for base::StdFileSystem:

[legend]Collaboration diagram for base::StdFileSystem:

[legend]List of all members.

Public Member Functions
	StdFileSystem ()
virtual	~StdFileSystem ()
virtual String	className () const
virtual Object &	clone () const
virtual ref< VDirectory >	root ()
	get the root directory of this VFileSystem (e.g. "/")
virtual ref< VDirectory >	temp ()
	get directory in which temporary files can be stored
virtual ref< VDirectory >	current ()
	get the current working directory
virtual void	setCurrent (const PathName &path) throw (path_not_found, io_error, std::invalid_argument)
	set the current directory (defaults to root)
virtual ref< VDirectory >	getDirectory (const PathName &path) throw (path_not_found, io_error, std::invalid_argument)
virtual ref< VFile >	getFile (const PathName &path) throw (path_not_found, io_error, std::invalid_argument)
virtual bool	exists (const PathName &path) throw (io_error)
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
	StdFileSystem (const StdFileSystem &fs)
Protected Attributes
ref< Directory >	currentDir
int	_refCount
bool	onUnreferenceEnabled

---

Constructor & Destructor Documentation

base::StdFileSystem::StdFileSystem (   )

Referenced by clone().

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

base::StdFileSystem::StdFileSystem (  const StdFileSystem &  fs  )  [inline, protected]

Definition at line 54 of file StdFileSystem.

---

Member Function Documentation

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

return the name of the object's class type. Must be defined by derived classes. Implements base::Object. Definition at line 41 of file StdFileSystem. References base::String. Referenced by clone().

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

Definition at line 42 of file StdFileSystem. References className(), NewNamedObj, and StdFileSystem().

virtual ref<VDirectory> base::StdFileSystem::current (   )  [virtual]

get the current working directory Implements base::VFileSystem.

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.

virtual bool base::StdFileSystem::exists (  const PathName &  path  )  throw (io_error) [virtual]

Implements base::VFileSystem.

virtual ref<VDirectory> base::StdFileSystem::getDirectory (  const PathName &  path  )  throw (path_not_found, io_error, std::invalid_argument) [virtual]

Implements base::VFileSystem.

virtual ref<VFile> base::StdFileSystem::getFile (  const PathName &  path  )  throw (path_not_found, io_error, std::invalid_argument) [virtual]

Implements base::VFileSystem.

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

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 ref<VDirectory> base::StdFileSystem::root (   )  [virtual]

get the root directory of this VFileSystem (e.g. "/") Implements base::VFileSystem.

virtual void base::StdFileSystem::setCurrent (  const PathName &  path  )  throw (path_not_found, io_error, std::invalid_argument) [virtual]

set the current directory (defaults to root) Implements base::VFileSystem.

virtual ref<VDirectory> base::StdFileSystem::temp (   )  [virtual]

get directory in which temporary files can be stored Implements base::VFileSystem.

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.

---

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<Directory> base::StdFileSystem::currentDir [protected]

Definition at line 56 of file StdFileSystem.

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

---

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

• base/StdFileSystem

---