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

#include <DEP_ContextOptionsFwd.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 T>
class UT_COWTransientReadHandle< T >

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 16 of file DEP_ContextOptionsFwd.h.

Constructor & Destructor Documentation

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

Definition at line 241 of file UT_COW.h.

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

Definition at line 246 of file UT_COW.h.

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

Definition at line 251 of file UT_COW.h.

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

Definition at line 256 of file UT_COW.h.

Member Function Documentation

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

Definition at line 301 of file UT_COW.h.

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

Test if this is a NULL pointer.

Definition at line 287 of file UT_COW.h.

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

Definition at line 292 of file UT_COW.h.

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

Definition at line 297 of file UT_COW.h.

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

Definition at line 261 of file UT_COW.h.

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

Definition at line 268 of file UT_COW.h.

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

Removes references, making this a null pointer.

Definition at line 281 of file UT_COW.h.


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