Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

RefCountProxy< Base > Class Template Reference

A "proxy" to use to make a reference-countable object whenever the object cannot inherit from ReferenceCount for some reason. More...

#include <referenceCount.h>

Inheritance diagram for RefCountProxy< Base >:

ReferenceCount List of all members.

Public Member Functions

 RefCountProxy ()
 RefCountProxy (const Base &copy)
 operator Base & ()
 operator const Base & () const
int get_ref_count () const
 Returns the current reference count.

int ref () const
 Explicitly increments the reference count.

int unref () const
 Explicitly decrements the reference count.

void test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.


Static Public Member Functions

TypeHandle get_class_type ()
void init_type ()

Private Attributes

Base _base

Static Private Attributes

TypeHandle _type_handle

Detailed Description

template<class Base>
class RefCountProxy< Base >

A "proxy" to use to make a reference-countable object whenever the object cannot inherit from ReferenceCount for some reason.

RefCountPr<MyClass> can be treated as an instance of MyClass directly, for the most part, except that it can be reference counted.

If you want to declare a RefCountProxy to something that does not have get_class_type(), you will have to define a template specialization on _get_type_handle() and _do_init_type(), as in typedObject.h.

Definition at line 111 of file referenceCount.h.


Constructor & Destructor Documentation

template<class Base>
RefCountProxy< Base >::RefCountProxy  )  [inline]
 

Definition at line 399 of file referenceCount.I.

template<class Base>
RefCountProxy< Base >::RefCountProxy const Base &  copy  )  [inline]
 

Definition at line 411 of file referenceCount.I.


Member Function Documentation

template<class Base>
TypeHandle RefCountProxy< Base >::get_class_type void   )  [inline, static]
 

Reimplemented from ReferenceCount.

Definition at line 119 of file referenceCount.h.

References RefCountObj< Base >::_type_handle, and INLINE.

int ReferenceCount::get_ref_count  )  const [inline, inherited]
 

Returns the current reference count.

Definition at line 183 of file referenceCount.I.

Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

template<class Base>
void RefCountProxy< Base >::init_type void   )  [static]
 

Reimplemented from ReferenceCount.

Definition at line 449 of file referenceCount.I.

template<class Base>
RefCountProxy< Base >::operator Base &  )  [inline]
 

Definition at line 423 of file referenceCount.I.

template<class Base>
RefCountProxy< Base >::operator const Base &  )  const [inline]
 

Definition at line 436 of file referenceCount.I.

int ReferenceCount::ref  )  const [inline, inherited]
 

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is the new reference count.

Definition at line 225 of file referenceCount.I.

Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

void ReferenceCount::test_ref_count_integrity  )  const [inline, inherited]
 

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.

References INLINE.

Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref  )  const [inline, inherited]
 

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is the new reference count.

Definition at line 293 of file referenceCount.I.

References INLINE.

Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().


Member Data Documentation

template<class Base>
Base RefCountProxy< Base >::_base [private]
 

Definition at line 125 of file referenceCount.h.

template<class Base>
TypeHandle RefCountProxy< Base >::_type_handle [static, private]
 

Reimplemented from ReferenceCount.

Definition at line 23 of file referenceCount.I.


The documentation for this class was generated from the following files:
Generated on Fri May 2 00:54:36 2003 for Panda by doxygen1.3