base::CacheFile Class Reference

Inheritance diagram for base::CacheFile:

[legend]Collaboration diagram for base::CacheFile:

[legend]List of all members.

Public Member Functions
virtual	~CacheFile ()
virtual String	className () const
virtual Object &	clone () const
virtual const PathName	path () const
virtual const PathName	pathName () const
virtual String	extension () const
	the file's extension (e.g. 'png')
virtual std::istream &	istream () const throw (io_error)
virtual std::ostream &	ostream () const throw (io_error)
virtual std::iostream &	iostream (std::iostream::openmode mode=(std::iostream::in|std::iostream::out)) const throw (io_error)
virtual void	close () const throw (io_error)
	close the file (can be re-opened again via istream/ostream/iostream() )
virtual bool	isDirectory () const
virtual bool	operator== (const VEntry &e) const
virtual const PathName	name () 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
	CacheFile (const CacheFile &f)
	CacheFile (const String &name, ref< VFile > actualFile)
Protected Attributes
ref< VFile >	actualFile
PathName	pathname
int	_refCount
bool	onUnreferenceEnabled
Friends
class	CacheDirectory
class	VFileSystem
class	VFile
class	VDirectory

---

Constructor & Destructor Documentation

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

base::CacheFile::CacheFile (  const CacheFile &  f  )  [inline, protected]

Definition at line 60 of file CacheFile. References actualFile, and f. Referenced by clone().

base::CacheFile::CacheFile (  const String &  name, ref< VFile >  actualFile )  [inline, protected]

Definition at line 62 of file CacheFile. References base::String.

---

Member Function Documentation

virtual String base::CacheFile::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 43 of file CacheFile. References base::String. Referenced by clone().

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

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

virtual void base::CacheFile::close (   )  const throw (io_error) [virtual]

close the file (can be re-opened again via istream/ostream/iostream() ) Implements base::VFile.

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 String base::CacheFile::extension (   )  const [inline, virtual]

the file's extension (e.g. 'png') Implements base::VFile. Definition at line 49 of file CacheFile. References base::PathName::extension(), and base::String.

virtual std::iostream& base::CacheFile::iostream (  std::iostream::openmode  mode = (std::iostream::in|std::iostream::out)  )  const throw (io_error) [virtual]

Implements base::VFile.

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

Implements base::VEntry. Definition at line 45 of file VFile.

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 std::istream& base::CacheFile::istream (   )  const throw (io_error) [virtual]

Implements base::VFile.

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 bool base::VEntry::operator== (  const VEntry &  e  )  const [inline, virtual, inherited]

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

virtual std::ostream& base::CacheFile::ostream (   )  const throw (io_error) [virtual]

Implements base::VFile.

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

Reimplemented from base::VEntry. Definition at line 46 of file CacheFile. References base::String. Referenced by pathName().

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

Reimplemented from base::VEntry. Definition at line 47 of file CacheFile. References base::PathName::name(), and path().

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

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 CacheDirectory [friend]

Definition at line 65 of file CacheFile.

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]

Reimplemented from base::VFile. Definition at line 66 of file CacheFile.

---

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<VFile> base::CacheFile::actualFile [protected]

Definition at line 58 of file CacheFile. Referenced by CacheFile().

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

---

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

• base/CacheFile

---