HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL > Class Template Reference

#include <GA_PageHandle.h>

Public Types

typedef T value_type
 

Public Member Functions

 GA_PageHandleT ()
 
 GA_PageHandleT (EXTERNAL_ATTRIB *attrib, int component=0)
 
 GA_PageHandleT (DETAIL *gdp, GA_AttributeOwner owner, const char *name, int component=0)
 
 ~GA_PageHandleT ()
 
void bind (EXTERNAL_ATTRIB *attrib, int component=0)
 
void bindUnsafe (EXTERNAL_ATTRIB *attrib, int component=0)
 
void bind (DETAIL *gdp, GA_AttributeOwner owner, const char *name, int component=0)
 
void setComponent (int comp)
 
EXTERNAL_ATTRIB * getAttribute () const
 
EXTERNAL_ATTRIB * operator-> () const
 
void bumpDataId () const
 
GA_DataId getDataId () const
 
void clear ()
 
void setDefaultValue (T value)
 
SYS_FORCE_INLINE bool isCurrentPageConstant () const
 
void makeConstant (T cval)
 
void setPageConstant (GA_PageNum pagenum, T values)
 
SYS_FORCE_INLINE bool isValid () const
 
SYS_FORCE_INLINE bool isInvalid () const
 
void setPage (GA_Offset pagebase)
 
T get (GA_Offset off) const
 
T getRelative (GA_PageOff rel) const
 
void set (GA_Offset off, T value)
 
void setRelative (GA_PageOff rel, T value)
 
T & value (GA_Offset off)
 
T & valueRelative (GA_PageOff rel)
 
void flushIfNeeded ()
 

Protected Attributes

T myMarshalledData [GA_PAGE_SIZE]
 
T * myDataPtr
 
INTERNAL_ATTRIB * myAttrib
 
GA_Offset myBaseOffset
 
int myComponent
 
bool myIsConstant
 

Detailed Description

template<typename T, typename TB, bool READ, bool WRITE, typename EXTERNAL_ATTRIB, typename INTERNAL_ATTRIB, typename DETAIL>
class GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >

Definition at line 37 of file GA_PageHandle.h.

Member Typedef Documentation

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
typedef T GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::value_type

Definition at line 40 of file GA_PageHandle.h.

Constructor & Destructor Documentation

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::GA_PageHandleT ( )
inline

Definition at line 42 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::GA_PageHandleT ( EXTERNAL_ATTRIB *  attrib,
int  component = 0 
)
inline

Definition at line 46 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::GA_PageHandleT ( DETAIL *  gdp,
GA_AttributeOwner  owner,
const char *  name,
int  component = 0 
)
template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::~GA_PageHandleT ( )
inline

Definition at line 59 of file GA_PageHandle.h.

Member Function Documentation

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::bind ( EXTERNAL_ATTRIB *  attrib,
int  component = 0 
)
inline

Definition at line 269 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::bind ( DETAIL *  gdp,
GA_AttributeOwner  owner,
const char *  name,
int  component = 0 
)
template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::bindUnsafe ( EXTERNAL_ATTRIB *  attrib,
int  component = 0 
)
inline

Bind unsafe does no checking of the attribute, assuming it is already a GA_ATINumeric.

Definition at line 290 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::bumpDataId ( ) const
inline

Definition at line 82 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::clear ( )
inline

Definition at line 96 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::flushIfNeeded ( )
template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
T GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::get ( GA_Offset  off) const
inline

Definition at line 143 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
EXTERNAL_ATTRIB* GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::getAttribute ( ) const
inline

Definition at line 76 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
GA_DataId GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::getDataId ( ) const
inline

Definition at line 88 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
T GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::getRelative ( GA_PageOff  rel) const
inline

Definition at line 147 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
SYS_FORCE_INLINE bool GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::isCurrentPageConstant ( ) const
inline

This returns if the page was constant when it was fetched. It may no longer be constant if someone wrote to it.

Definition at line 121 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
SYS_FORCE_INLINE bool GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::isInvalid ( ) const
inline

Definition at line 139 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
SYS_FORCE_INLINE bool GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::isValid ( ) const
inline

Definition at line 138 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::makeConstant ( T  cval)
inline

Definition at line 124 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
EXTERNAL_ATTRIB* GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::operator-> ( ) const
inline

Definition at line 77 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::set ( GA_Offset  off,
T  value 
)
inline

Definition at line 153 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::setComponent ( int  comp)
inline

Somewhat expensive as it must flush and rebind! It is preferred to have several page handles, one for each component.

Definition at line 74 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::setDefaultValue ( T  value)
inline

Sets the default value If the attribute is unbound, this is the value that will be read.

Definition at line 107 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::setPage ( GA_Offset  pagebase)
inline

Definition at line 304 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::setPageConstant ( GA_PageNum  pagenum,
T  values 
)
inline

Sets all components of all elements of the specified page to the given values. NOTE: The length of values must be equal to the tuple size.

Definition at line 132 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
void GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::setRelative ( GA_PageOff  rel,
T  value 
)
inline

Definition at line 157 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
T& GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::value ( GA_Offset  off)
inline

Definition at line 165 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
T& GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::valueRelative ( GA_PageOff  rel)
inline

Definition at line 169 of file GA_PageHandle.h.

Member Data Documentation

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
INTERNAL_ATTRIB* GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::myAttrib
protected

Definition at line 183 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
GA_Offset GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::myBaseOffset
protected

Definition at line 184 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
int GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::myComponent
protected

Definition at line 185 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
T* GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::myDataPtr
protected

Definition at line 182 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
bool GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::myIsConstant
protected

Definition at line 186 of file GA_PageHandle.h.

template<typename T , typename TB , bool READ, bool WRITE, typename EXTERNAL_ATTRIB , typename INTERNAL_ATTRIB , typename DETAIL >
T GA_PageHandleT< T, TB, READ, WRITE, EXTERNAL_ATTRIB, INTERNAL_ATTRIB, DETAIL >::myMarshalledData[GA_PAGE_SIZE]
protected

Definition at line 181 of file GA_PageHandle.h.

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