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_Attribute &	operator* () const
	Define the * operator to dereference the attribute. More...

const GA_Attribute *	operator-> () const
	An -> operator to access the attribute. More...

GA_ROAttributeRef &	operator= (const GA_Attribute *attrib)
	Assignment operators. More...

GA_ROAttributeRef &	operator= (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

bool	isDict () const

GA_StorageClass	getStorageClass () const

int	getTupleSize () const

const GA_Attribute *	get () const

	operator const GA_Attribute * () const

SYS_SAFE_BOOL	operator bool () const

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_AIFNumericArray *	getAIFNumericArray () const

const GA_AIFSharedStringArray *	getAIFSharedStringArray () const

const GA_AIFSharedDictTuple *	getAIFSharedDictTuple () const

const GA_AIFSharedStringTuple *	getAIFSharedStringTuple () const

const GA_AIFIndexPair *	getAIFIndexPair () 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 217 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 225 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 339 of file GA_AttributeRef.h.

const GA_AIFCopyData* GA_ROAttributeRef::getAIFCopyData ( ) const

inline

Definition at line 346 of file GA_AttributeRef.h.

const GA_AIFIndexPair* GA_ROAttributeRef::getAIFIndexPair ( ) const

inline

Definition at line 389 of file GA_AttributeRef.h.

const GA_AIFInterp* GA_ROAttributeRef::getAIFInterp ( ) const

inline

Definition at line 354 of file GA_AttributeRef.h.

const GA_AIFMath* GA_ROAttributeRef::getAIFMath ( ) const

inline

Definition at line 350 of file GA_AttributeRef.h.

const GA_AIFNumericArray* GA_ROAttributeRef::getAIFNumericArray ( ) const

inline

Definition at line 366 of file GA_AttributeRef.h.

const GA_AIFSharedDictTuple* GA_ROAttributeRef::getAIFSharedDictTuple ( ) const

inline

Definition at line 379 of file GA_AttributeRef.h.

const GA_AIFSharedStringArray* GA_ROAttributeRef::getAIFSharedStringArray ( ) const

inline

Definition at line 372 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 362 of file GA_AttributeRef.h.

const GA_AIFTuple* GA_ROAttributeRef::getAIFTuple ( ) const

inline

Definition at line 358 of file GA_AttributeRef.h.

const GA_Attribute* GA_ROAttributeRef::getAttribute ( ) const

inline

Definition at line 342 of file GA_AttributeRef.h.

GA_StorageClass GA_ROAttributeRef::getStorageClass ( ) const

inline

Definition at line 307 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 324 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::isDict ( ) const

inline

Definition at line 302 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isFloat ( ) const

inline

Determine the storage type of the underlying attribute.

Definition at line 291 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isInt ( ) const

inline

Definition at line 294 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 278 of file GA_AttributeRef.h.

bool GA_ROAttributeRef::isString ( ) const

inline

Definition at line 297 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 272 of file GA_AttributeRef.h.

SYS_SAFE_BOOL GA_ROAttributeRef::operator bool ( ) const

inline

Definition at line 341 of file GA_AttributeRef.h.

GA_ROAttributeRef::operator const GA_Attribute * ( ) const

inline

Definition at line 340 of file GA_AttributeRef.h.

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

inline

Comparison operator.

Definition at line 265 of file GA_AttributeRef.h.

const GA_Attribute& GA_ROAttributeRef::operator* ( ) const

inline

Define the * operator to dereference the attribute.

Definition at line 237 of file GA_AttributeRef.h.

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

inline

An -> operator to access the attribute.

Definition at line 240 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 246 of file GA_AttributeRef.h.

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

inline

Comparison operator.

Definition at line 260 of file GA_AttributeRef.h.

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

GA/GA_AttributeRef.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation