HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
GA_RWAttributeRef Class Reference

This class provides a way to manage a reference to an attribute permitting Read-Write access. More...

#include <GA_AttributeRef.h>

+ Inheritance diagram for GA_RWAttributeRef:

Public Member Functions

 GA_RWAttributeRef (GA_Attribute *attrib=0)
 
- Public Member Functions inherited from GA_WOAttributeRef
 GA_WOAttributeRef (GA_Attribute *attrib=0)
 
GA_Attribute & operator* () const
 Define the * operator to dereference the attribute. More...
 
GA_Attribute * operator-> () const
 Define the -> operator to access the attribute. More...
 
GA_WOAttributeRef & operator= (GA_Attribute *attrib)
 Assignment operator. More...
 
bool operator== (const GA_WOAttributeRef &src) const
 Comparison operator. More...
 
bool operator!= (const GA_WOAttributeRef &src) const
 Comparison operator. More...
 
bool isValid () const
 Test to see if the attribute reference refers to a valid attribute. More...
 
bool isInvalid () const
 Test to see if the attribute reference refers to a valid attribute. More...
 
void clear ()
 Method to clear the handle (so that it is no longer valid) More...
 
bool setTypeInfo (GA_TypeInfo info)
 Set type information on the attribute. More...
 
bool isFloat () const
 Determine the storage type of the underlying attribute. More...
 
bool isInt () const
 
bool isString () const
 
bool isDict () const
 
GA_StorageClass getStorageClass () const
 
int getTupleSize () const
 
void setTupleSize (int size)
 
GA_Attribute * get () const
 
 operator GA_Attribute * () const
 
SYS_SAFE_BOOL operator bool () const
 
GA_Attribute * getAttribute () const
 
const GA_AIFCopyData * getAIFCopyData () const
 
const GA_AIFMath * getAIFMath () const
 
const GA_AIFInterp * getAIFInterp () const
 
const GA_AIFTuple * getAIFTuple () const
 
const GA_AIFStringTuple * getAIFStringTuple () const
 
const GA_AIFSharedDictTuple * getAIFSharedDictTuple () const
 
const GA_AIFSharedDictArray * getAIFSharedDictArray () const
 
const GA_AIFIndexPair * getAIFIndexPair () const
 
const GA_AIFNumericArray * getAIFNumericArray () const
 
const GA_AIFSharedStringArray * getAIFSharedStringArray () const
 

Detailed Description

This class provides a way to manage a reference to an attribute permitting Read-Write access.

Examples:
field3d/f3d_io.C, SIM/SIM_SolverHair.C, and SOP/SOP_BouncyAgent.C.

Definition at line 202 of file GA_AttributeRef.h.

Constructor & Destructor Documentation

GA_RWAttributeRef::GA_RWAttributeRef ( GA_Attribute *  attrib = 0)

Default constructor. If an attribute is passed in, the ref will be valid. Otherwise, it will be invalid.

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