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

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

#include <GA_AttributeRef.h>

+ Inheritance diagram for GA_WOAttributeRef:

Public Member Functions

 GA_WOAttributeRef (GA_Attribute *attrib=0)
 
GA_Attributeoperator* () const
 Define the * operator to dereference the attribute. More...
 
GA_Attributeoperator-> () const
 Define the -> operator to access the attribute. More...
 
GA_WOAttributeRefoperator= (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
 
GA_StorageClass getStorageClass () const
 
int getTupleSize () const
 
void setTupleSize (int size)
 
GA_Attributeget () const
 
 operator GA_Attribute * () const
 
SYS_SAFE_BOOL operator bool () const
 
GA_AttributegetAttribute () const
 
const GA_AIFCopyDatagetAIFCopyData () const
 
const GA_AIFMathgetAIFMath () const
 
const GA_AIFInterp * getAIFInterp () const
 
const GA_AIFTuplegetAIFTuple () const
 
const GA_AIFStringTuplegetAIFStringTuple () const
 
const GA_AIFIndexPairgetAIFIndexPair () const
 
const GA_AIFNumericArraygetAIFNumericArray () const
 
const GA_AIFSharedStringArraygetAIFSharedStringArray () const
 

Friends

class GA_ROAttributeRef
 

Detailed Description

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

Definition at line 35 of file GA_AttributeRef.h.

Constructor & Destructor Documentation

GA_WOAttributeRef::GA_WOAttributeRef ( GA_Attribute attrib = 0)

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

Member Function Documentation

void GA_WOAttributeRef::clear ( )

Method to clear the handle (so that it is no longer valid)

GA_Attribute* GA_WOAttributeRef::get ( ) const
inline

Definition at line 119 of file GA_AttributeRef.h.

const GA_AIFCopyData* GA_WOAttributeRef::getAIFCopyData ( ) const
inline

Definition at line 126 of file GA_AttributeRef.h.

const GA_AIFIndexPair* GA_WOAttributeRef::getAIFIndexPair ( ) const
inline
Examples:
SOP/SOP_BouncyAgent.C.

Definition at line 146 of file GA_AttributeRef.h.

const GA_AIFInterp* GA_WOAttributeRef::getAIFInterp ( ) const
inline

Definition at line 134 of file GA_AttributeRef.h.

const GA_AIFMath* GA_WOAttributeRef::getAIFMath ( ) const
inline

Definition at line 130 of file GA_AttributeRef.h.

const GA_AIFNumericArray* GA_WOAttributeRef::getAIFNumericArray ( ) const
inline

Definition at line 150 of file GA_AttributeRef.h.

const GA_AIFSharedStringArray* GA_WOAttributeRef::getAIFSharedStringArray ( ) const
inline

Definition at line 156 of file GA_AttributeRef.h.

const GA_AIFStringTuple* GA_WOAttributeRef::getAIFStringTuple ( ) const
inline

Definition at line 142 of file GA_AttributeRef.h.

const GA_AIFTuple* GA_WOAttributeRef::getAIFTuple ( ) const
inline

Definition at line 138 of file GA_AttributeRef.h.

GA_Attribute* GA_WOAttributeRef::getAttribute ( ) const
inline

Definition at line 122 of file GA_AttributeRef.h.

GA_StorageClass GA_WOAttributeRef::getStorageClass ( ) const
inline

Definition at line 96 of file GA_AttributeRef.h.

int GA_WOAttributeRef::getTupleSize ( ) const
inline

Tuple size of the attribute. Non-tuple types are treated as size one.

Definition at line 106 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::isFloat ( ) const
inline

Determine the storage type of the underlying attribute.

Definition at line 84 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::isInt ( ) const
inline

Definition at line 87 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::isInvalid ( ) const
inline

Test to see if the attribute reference refers to a valid attribute.

Definition at line 72 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::isString ( ) const
inline

Definition at line 90 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::isValid ( ) const
inline

Test to see if the attribute reference refers to a valid attribute.

Examples:
field3d/f3d_io.C.

Definition at line 66 of file GA_AttributeRef.h.

SYS_SAFE_BOOL GA_WOAttributeRef::operator bool ( ) const
inline

Definition at line 121 of file GA_AttributeRef.h.

GA_WOAttributeRef::operator GA_Attribute * ( ) const
inline

Definition at line 120 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::operator!= ( const GA_WOAttributeRef src) const
inline

Comparison operator.

Definition at line 59 of file GA_AttributeRef.h.

GA_Attribute& GA_WOAttributeRef::operator* ( ) const
inline

Define the * operator to dereference the attribute.

Definition at line 43 of file GA_AttributeRef.h.

GA_Attribute* GA_WOAttributeRef::operator-> ( ) const
inline

Define the -> operator to access the attribute.

Definition at line 46 of file GA_AttributeRef.h.

GA_WOAttributeRef& GA_WOAttributeRef::operator= ( GA_Attribute attrib)

Assignment operator.

bool GA_WOAttributeRef::operator== ( const GA_WOAttributeRef src) const
inline

Comparison operator.

Definition at line 53 of file GA_AttributeRef.h.

void GA_WOAttributeRef::setTupleSize ( int  size)
inline

Definition at line 113 of file GA_AttributeRef.h.

bool GA_WOAttributeRef::setTypeInfo ( GA_TypeInfo  info)

Set type information on the attribute.

Examples:
SIM/SIM_SolverHair.C.

Friends And Related Function Documentation

friend class GA_ROAttributeRef
friend

Definition at line 173 of file GA_AttributeRef.h.


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