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

#include <UT_COW.h>

Public Member Functions

 UT_COWTransientReadHandle ()
 
 ~UT_COWTransientReadHandle ()
 
 UT_COWTransientReadHandle (const UT_COWTransientReadHandle< Data > &src)
 
 UT_COWTransientReadHandle (const UT_COWHandle< Data > &src)
 
const
UT_COWTransientReadHandle
< Data > & 
operator= (const UT_COWTransientReadHandle< Data > &src)
 
const
UT_COWTransientReadHandle
< Data > & 
operator= (const UT_COWHandle< Data > &src)
 
void resetHandle ()
 Removes references, making this a null pointer. More...
 
bool isNull () const
 Test if this is a NULL pointer. More...
 
const Data & operator* () const
 
const Data * operator-> () const
 
const Data * get () const
 

Detailed Description

template<typename Data>
class UT_COWTransientReadHandle< Data >

Transient Read Handles are simply accessors to the internal data of the original handle. Unlike normal read handles, transient read handles don't result in a tracked reference to the underlying data, and so have lower overhead, but are unsafe to use outside the scope of, or after any changes to, the original handle. Write handles will not be aware of any active transient read handles, so errors in this usage will not trigger assertions. In fact, no write handles to the underlying data should exist during the entire scope of a transient read handle.

You are not allowed to edit the underlying data, so many read handles may be sharing the same underlying data.

Definition at line 33 of file UT_COW.h.

Constructor & Destructor Documentation

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

Definition at line 242 of file UT_COW.h.

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

Definition at line 247 of file UT_COW.h.

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

Definition at line 252 of file UT_COW.h.

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

Definition at line 257 of file UT_COW.h.

Member Function Documentation

template<typename Data>
const Data* UT_COWTransientReadHandle< Data >::get ( ) const
inline

Definition at line 302 of file UT_COW.h.

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

Test if this is a NULL pointer.

Definition at line 288 of file UT_COW.h.

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

Definition at line 293 of file UT_COW.h.

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

Definition at line 298 of file UT_COW.h.

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

Definition at line 262 of file UT_COW.h.

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

Definition at line 269 of file UT_COW.h.

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

Removes references, making this a null pointer.

Definition at line 282 of file UT_COW.h.


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