Producer::Referenced Class Reference

Inheritance diagram for Producer::Referenced:

Producer::Block Producer::BlockingQueue< T > Producer::Camera Producer::Camera::Callback Producer::Camera::Lens Producer::Camera::SceneHandler Producer::Camera::UpdateCallback Producer::CameraConfig Producer::CameraGroup Producer::CameraGroup::Callback Producer::CameraGroup::StatsHandler Producer::InputArea Producer::Keyboard Producer::KeyboardMouse Producer::KeyboardMouseCallback Producer::RefBarrier Producer::Reffed< T > Producer::RenderSurface Producer::RenderSurface::Callback Producer::Trackball Producer::VisualChooser Producer::Window3D Producer::Window3D::KeyboardCallback List of all members.

Public Member Functions

 Referenced ()
 Referenced (const Referenced &)
Referencedoperator= (Referenced &)
void ref () const
void unref () const
void unref_nodelete () const
int getReferenceCount () const

Protected Member Functions

virtual ~Referenced ()

Protected Attributes

int _refCount

Detailed Description

Base class from providing referencing counted objects.


Constructor & Destructor Documentation

Producer::Referenced::Referenced (  )  [inline]

Producer::Referenced::Referenced ( const Referenced  )  [inline]

virtual Producer::Referenced::~Referenced (  )  [inline, protected, virtual]


Member Function Documentation

Referenced& Producer::Referenced::operator= ( Referenced  )  [inline]

void Producer::Referenced::ref (  )  const [inline]

increment the reference count by one, indicating that this object has another pointer which is referencing it.

void Producer::Referenced::unref (  )  const [inline]

decrement the reference count by one, indicating that a pointer to this object is referencing it. If the reference count goes to zero, it is assumed that this object is no longer referenced and is automatically deleted.

void Producer::Referenced::unref_nodelete (  )  const [inline]

decrement the reference count by one, indicating that a pointer to this object is referencing it. However, do not delete it, even if ref count goes to 0. Warning, unref_nodelete() should only be called if the user knows exactly who will be resonsible for, one should prefer unref() over unref_nodelete() as the later can lead to memory leaks.

int Producer::Referenced::getReferenceCount (  )  const [inline]

return the number pointers currently referencing this object.


Member Data Documentation

int Producer::Referenced::_refCount [mutable, protected]


The documentation for this class was generated from the following file:
Generated on Sat Dec 30 20:36:54 2006 for producer by  doxygen 1.5.1