HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GA_RWBatchHandleS Class Reference

#include <GA_Handle.h>

Public Member Functions

 GA_RWBatchHandleS ()
 
 GA_RWBatchHandleS (GA_Attribute *attrib)
 
 GA_RWBatchHandleS (GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
void operator= (GA_Attribute *attrib)
 
void bind (GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
void bind (GA_Attribute *attrib, int minsize=1)
 Bind the handle to the given attribute. More...
 
GA_AttributegetAttribute () const
 Access to attribute. More...
 
int getTupleSize () const
 Tuple size of the attribute. More...
 
void clear ()
 Clear the handle. More...
 
SYS_FORCE_INLINE const char * get (GA_Offset off, int comp=0) const
 Get the string at the given offset. More...
 
SYS_FORCE_INLINE GA_StringIndexType getIndex (GA_Offset off, int comp=0) const
 Get the string index at the given offset. More...
 
SYS_FORCE_INLINE void set (GA_Offset off, const UT_StringHolder &str)
 Store the str at the given offset. More...
 
SYS_FORCE_INLINE void set (const GA_Range &range, const UT_StringHolder &str)
 
SYS_FORCE_INLINE void set (GA_Offset off, int comp, const UT_StringHolder &str)
 
SYS_FORCE_INLINE void set (const GA_Range &range, int comp, const UT_StringHolder &str)
 
SYS_FORCE_INLINE void set (GA_Offset off, GA_StringIndexType idx)
 Store the string indexed by the idx at the given offset. More...
 
SYS_FORCE_INLINE void set (const GA_Range &range, GA_StringIndexType idx)
 
SYS_FORCE_INLINE void set (GA_Offset off, int comp, GA_StringIndexType idx)
 
SYS_FORCE_INLINE void set (const GA_Range &range, int comp, GA_StringIndexType idx)
 
SYS_FORCE_INLINE bool isValid () const
 
SYS_FORCE_INLINE bool isInvalid () const
 

Protected Attributes

GA_ATIStringmyAttrib
 
GA_ATIStringDelayedWriter myWriter
 

Detailed Description

Read-Write string handle Batches all reference counts until a flush() or its destructor. Because it tracks this locally, you MUST create a separate one per thread! (Even if this were made thread safe, that would defeat the purpose of this, which is to use thread-local reference counts to avoid write contention) NOTE: This bumps the data ID of any attribute it's bound to upon destruction.

Definition at line 1012 of file GA_Handle.h.

Constructor & Destructor Documentation

GA_RWBatchHandleS::GA_RWBatchHandleS ( )
inline

Definition at line 1015 of file GA_Handle.h.

GA_RWBatchHandleS::GA_RWBatchHandleS ( GA_Attribute attrib)
inline

Definition at line 1019 of file GA_Handle.h.

GA_RWBatchHandleS::GA_RWBatchHandleS ( GA_Detail gdp,
GA_AttributeOwner  owner,
const UT_StringRef name,
int  minsize = 1 
)

Member Function Documentation

void GA_RWBatchHandleS::bind ( GA_Detail gdp,
GA_AttributeOwner  owner,
const UT_StringRef name,
int  minsize = 1 
)
void GA_RWBatchHandleS::bind ( GA_Attribute attrib,
int  minsize = 1 
)
inline

Bind the handle to the given attribute.

Definition at line 1032 of file GA_Handle.h.

void GA_RWBatchHandleS::clear ( )
inline

Clear the handle.

Definition at line 1048 of file GA_Handle.h.

SYS_FORCE_INLINE const char* GA_RWBatchHandleS::get ( GA_Offset  off,
int  comp = 0 
) const
inline

Get the string at the given offset.

Definition at line 1061 of file GA_Handle.h.

GA_Attribute* GA_RWBatchHandleS::getAttribute ( ) const
inline

Access to attribute.

Definition at line 1043 of file GA_Handle.h.

SYS_FORCE_INLINE GA_StringIndexType GA_RWBatchHandleS::getIndex ( GA_Offset  off,
int  comp = 0 
) const
inline

Get the string index at the given offset.

Definition at line 1069 of file GA_Handle.h.

int GA_RWBatchHandleS::getTupleSize ( ) const
inline

Tuple size of the attribute.

Definition at line 1045 of file GA_Handle.h.

SYS_FORCE_INLINE bool GA_RWBatchHandleS::isInvalid ( ) const
inline

Validity checks

Definition at line 1057 of file GA_Handle.h.

SYS_FORCE_INLINE bool GA_RWBatchHandleS::isValid ( ) const
inline

Validity checks

Definition at line 1056 of file GA_Handle.h.

void GA_RWBatchHandleS::operator= ( GA_Attribute attrib)
inline

Definition at line 1025 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( GA_Offset  off,
const UT_StringHolder str 
)
inline

Store the str at the given offset.

Definition at line 1078 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( const GA_Range range,
const UT_StringHolder str 
)
inline

Definition at line 1082 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( GA_Offset  off,
int  comp,
const UT_StringHolder str 
)
inline

Definition at line 1086 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( const GA_Range range,
int  comp,
const UT_StringHolder str 
)
inline

Definition at line 1093 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( GA_Offset  off,
GA_StringIndexType  idx 
)
inline

Store the string indexed by the idx at the given offset.

Definition at line 1098 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( const GA_Range range,
GA_StringIndexType  idx 
)
inline

Definition at line 1102 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( GA_Offset  off,
int  comp,
GA_StringIndexType  idx 
)
inline

Definition at line 1106 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWBatchHandleS::set ( const GA_Range range,
int  comp,
GA_StringIndexType  idx 
)
inline

Definition at line 1113 of file GA_Handle.h.

Member Data Documentation

GA_ATIString* GA_RWBatchHandleS::myAttrib
protected

Definition at line 1118 of file GA_Handle.h.

GA_ATIStringDelayedWriter GA_RWBatchHandleS::myWriter
protected

Definition at line 1119 of file GA_Handle.h.


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