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

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

#include <GA_AttributeRef.h>

Public Member Functions

 GA_ROAttributeRef (const GA_Attribute *attrib=0)
 
 GA_ROAttributeRef (const GA_RWAttributeRef &src)
 Conversion constructor (implicit) More...
 
const GA_Attributeoperator* () const
 Define the * operator to dereference the attribute. More...
 
const GA_Attributeoperator-> () const
 An -> operator to access the attribute. More...
 
GA_ROAttributeRefoperator= (const GA_Attribute *attrib)
 Assignment operators. More...
 
GA_ROAttributeRefoperator= (const GA_RWAttributeRef &src)
 
bool operator== (const GA_ROAttributeRef &src) const
 Comparison operator. More...
 
bool operator!= (const GA_ROAttributeRef &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...
 
GA_TypeInfo getTypeInfo () const
 
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
 
const GA_Attributeget () const
 
 operator const GA_Attribute * () const
 
SYS_SAFE_BOOL operator bool () const
 
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_AIFNumericArraygetAIFNumericArray () const
 
const GA_AIFSharedStringArraygetAIFSharedStringArray () const
 
const GA_AIFSharedStringTuplegetAIFSharedStringTuple () const
 
const GA_AIFIndexPairgetAIFIndexPair () const
 
const char * getString (GA_Offset element_index, int tuple_index=0) const
 

Detailed Description

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

Definition at line 194 of file GA_AttributeRef.h.

Constructor & Destructor Documentation

GA_ROAttributeRef::GA_ROAttributeRef ( const GA_Attribute attrib = 0)

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

GA_ROAttributeRef::GA_ROAttributeRef ( const GA_RWAttributeRef src)
inline

Conversion constructor (implicit)

Definition at line 202 of file GA_AttributeRef.h.

Member Function Documentation

void GA_ROAttributeRef::clear ( )

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

const GA_Attribute* GA_ROAttributeRef::get ( ) const
inline

Definition at line 308 of file GA_AttributeRef.h.

const GA_AIFCopyData* GA_ROAttributeRef::getAIFCopyData ( ) const
inline

Definition at line 315 of file GA_AttributeRef.h.

const GA_AIFIndexPair* GA_ROAttributeRef::getAIFIndexPair ( ) const
inline

Definition at line 351 of file GA_AttributeRef.h.

const GA_AIFInterp* GA_ROAttributeRef::getAIFInterp ( ) const
inline

Definition at line 323 of file GA_AttributeRef.h.

const GA_AIFMath* GA_ROAttributeRef::getAIFMath ( ) const
inline

Definition at line 319 of file GA_AttributeRef.h.

const GA_AIFNumericArray* GA_ROAttributeRef::getAIFNumericArray ( ) const
inline

Definition at line 335 of file GA_AttributeRef.h.

const GA_AIFSharedStringArray* GA_ROAttributeRef::getAIFSharedStringArray ( ) const
inline

Definition at line 341 of file GA_AttributeRef.h.

const GA_AIFSharedStringTuple* GA_ROAttributeRef::getAIFSharedStringTuple ( ) const

Shared String Tuple Interface. This allows you to get integer or string values out of the attribute.

const GA_AIFStringTuple* GA_ROAttributeRef::getAIFStringTuple ( ) const
inline

Definition at line 331 of file GA_AttributeRef.h.

const GA_AIFTuple* GA_ROAttributeRef::getAIFTuple ( ) const
inline

Definition at line 327 of file GA_AttributeRef.h.

const GA_Attribute* GA_ROAttributeRef::getAttribute ( ) const
inline

Definition at line 311 of file GA_AttributeRef.h.

GA_StorageClass GA_ROAttributeRef::getStorageClass ( ) const
inline

Definition at line 280 of file GA_AttributeRef.h.

const char* GA_ROAttributeRef::getString ( GA_Offset  element_index,
int  tuple_index = 0 
) const

Look up the AIFStringTuple and evaluate the string. If there is no AIF support, this will return a NULL pointer

int GA_ROAttributeRef::getTupleSize ( ) const
inline

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

Definition at line 295 of file GA_AttributeRef.h.

GA_TypeInfo GA_ROAttributeRef::getTypeInfo ( ) const

Get type information on the attribute, with invalid references returning GA_TYPE_VOID.

bool GA_ROAttributeRef::isFloat ( ) const
inline

Determine the storage type of the underlying attribute.

Definition at line 268 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isInt ( ) const
inline

Definition at line 271 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isInvalid ( ) const
inline

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

Definition at line 255 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isString ( ) const
inline

Definition at line 274 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isValid ( ) const
inline

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

Definition at line 249 of file GA_AttributeRef.h.

SYS_SAFE_BOOL GA_ROAttributeRef::operator bool ( ) const
inline

Definition at line 310 of file GA_AttributeRef.h.

GA_ROAttributeRef::operator const GA_Attribute * ( ) const
inline

Definition at line 309 of file GA_AttributeRef.h.

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

Comparison operator.

Definition at line 242 of file GA_AttributeRef.h.

const GA_Attribute& GA_ROAttributeRef::operator* ( ) const
inline

Define the * operator to dereference the attribute.

Definition at line 214 of file GA_AttributeRef.h.

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

An -> operator to access the attribute.

Definition at line 217 of file GA_AttributeRef.h.

GA_ROAttributeRef& GA_ROAttributeRef::operator= ( const GA_Attribute attrib)

Assignment operators.

GA_ROAttributeRef& GA_ROAttributeRef::operator= ( const GA_RWAttributeRef src)
inline

Definition at line 223 of file GA_AttributeRef.h.

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

Comparison operator.

Definition at line 237 of file GA_AttributeRef.h.


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