HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_COWWriteHandle< Data > Class Template Reference

#include <UT_COW.h>

Public Member Functions

 UT_COWWriteHandle ()
 
 ~UT_COWWriteHandle ()
 
 UT_COWWriteHandle (const UT_COWWriteHandle< Data > &src)
 
 UT_COWWriteHandle (UT_COWHandle< Data > *src)
 
const UT_COWWriteHandle< Data > & operator= (const UT_COWWriteHandle< Data > &src)
 
const UT_COWWriteHandle< Data > & operator= (UT_COWHandle< Data > *src)
 
void resetHandle ()
 Turns this into a null handle to drop references. More...
 
bool isNull () const
 Test if this is a NULL pointer. More...
 
Data & operator* () const
 
Data * operator-> () const
 
int getRefCount () const
 

Detailed Description

template<typename Data>
class UT_COWWriteHandle< Data >

A write handle can be thought of as a pointer to the actual data. It allows you to modify the underlying data. To do this, it will unique the plain-handle's data so no outstanding readlocks will be affected by the writes.

Building read handles while a write handle is active is valid so long as no dereference occurs during the lifetime of the read handle.

Examples:
field3d/f3d_io.C, GEO/GEO_VoxelTranslator.C, standalone/gengeovolume.C, and standalone/geo2voxel.C.

Definition at line 34 of file UT_COW.h.

Constructor & Destructor Documentation

template<typename Data>
UT_COWWriteHandle< Data >::UT_COWWriteHandle ( )
inline

Definition at line 325 of file UT_COW.h.

template<typename Data>
UT_COWWriteHandle< Data >::~UT_COWWriteHandle ( )
inline

Definition at line 330 of file UT_COW.h.

template<typename Data>
UT_COWWriteHandle< Data >::UT_COWWriteHandle ( const UT_COWWriteHandle< Data > &  src)
inline

Definition at line 335 of file UT_COW.h.

template<typename Data>
UT_COWWriteHandle< Data >::UT_COWWriteHandle ( UT_COWHandle< Data > *  src)
inline

Definition at line 341 of file UT_COW.h.

Member Function Documentation

template<typename Data>
int UT_COWWriteHandle< Data >::getRefCount ( ) const
inline

Definition at line 427 of file UT_COW.h.

template<typename Data>
bool UT_COWWriteHandle< Data >::isNull ( ) const
inline

Test if this is a NULL pointer.

Definition at line 389 of file UT_COW.h.

template<typename Data>
Data& UT_COWWriteHandle< Data >::operator* ( void  ) const
inline

Definition at line 394 of file UT_COW.h.

template<typename Data>
Data* UT_COWWriteHandle< Data >::operator-> ( void  ) const
inline

Definition at line 413 of file UT_COW.h.

template<typename Data>
const UT_COWWriteHandle<Data>& UT_COWWriteHandle< Data >::operator= ( const UT_COWWriteHandle< Data > &  src)
inline

Passing write handles by value is fine as the users understand they all share the same underlying data, so is responsible for thread safety, etc.

Definition at line 350 of file UT_COW.h.

template<typename Data>
const UT_COWWriteHandle<Data>& UT_COWWriteHandle< Data >::operator= ( UT_COWHandle< Data > *  src)
inline

Converting from a handle into a write handle can only be done once. This prevents other threads or methods from invalidating our uniqueness property. Note we up case from a pointer to a UT_COWHandle, not from a UT_COWHandle. This avoids people accidentally using an temporary as the source and underlines that write handles are like pointers while read handles are like values.

Definition at line 367 of file UT_COW.h.

template<typename Data>
void UT_COWWriteHandle< Data >::resetHandle ( )
inline

Turns this into a null handle to drop references.

Definition at line 382 of file UT_COW.h.


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