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

Manager to keep track of global handle to name mappings. More...

#include <GA_IntrinsicManager.h>

Classes

class  iterator
 
class  Registrar
 

Public Member Functions

int getLocalEntries () const
 Return the number of local handles defined in the manager. More...
 
void extractNames (UT_StringArray &names) const
 Extract all attribute names. More...
 
const UT_StringHoldergetName (GA_LocalIntrinsic handle) const
 Look up an attribute name from the given handle. More...
 
iterator begin () const
 Start traversal of intrinsic attributes names. More...
 
GA_LocalIntrinsic getLocalHandle (const UT_StringRef &token) const
 
GA_LocalIntrinsic getLocalHandle (GA_GlobalIntrinsic ghandle) const
 
GA_GlobalIntrinsic getGlobalHandle (GA_LocalIntrinsic lhandle) const
 
GA_StorageClass getStorage (const UT_StringRef &name) const
 
GA_StorageClass getStorage (GA_LocalIntrinsic handle) const
 
bool getReadOnly (const UT_StringRef &name) const
 
bool getReadOnly (GA_LocalIntrinsic handle) const
 
int getUserId (const UT_StringRef &name) const
 
int getUserId (GA_LocalIntrinsic handle) const
 
const UT_OptionsgetOptions (const UT_StringRef &name) const
 
const UT_OptionsgetOptions (GA_LocalIntrinsic handle) const
 

Static Public Member Functions

static GA_GlobalIntrinsic getGlobalHandle (const UT_StringRef &token)
 Get the global id associated with a given token. More...
 
static GA_GlobalIntrinsic registerGlobalHandle (const UT_StringHolder &token)
 Register a global token (returns the existing handle if it's found) More...
 
static const UT_StringHoldergetGlobalName (GA_GlobalIntrinsic handle)
 Find the token associated with the given global handle. More...
 

Friends

class GA_PrimitiveFactory
 
class GA_PrimitiveDefinition
 
class Registrar
 

Detailed Description

Manager to keep track of global handle to name mappings.

Each GA_PrimitiveFactory maintains a list of intrinsic attributes. These attribute provide a mechanism to query information about primitives without having knowledge of the actual structure of the primitive.

There is a unique handle (or id) for each attribute name. This class maintains the mapping between name and handle.

Definition at line 39 of file GA_IntrinsicManager.h.

Member Function Documentation

iterator GA_IntrinsicManager::begin ( void  ) const
inline

Start traversal of intrinsic attributes names.

Definition at line 286 of file GA_IntrinsicManager.h.

void GA_IntrinsicManager::extractNames ( UT_StringArray names) const

Extract all attribute names.

static GA_GlobalIntrinsic GA_IntrinsicManager::getGlobalHandle ( const UT_StringRef token)
static

Get the global id associated with a given token.

GA_GlobalIntrinsic GA_IntrinsicManager::getGlobalHandle ( GA_LocalIntrinsic  lhandle) const
inline

Mapping between global and local attributes

Definition at line 62 of file GA_IntrinsicManager.h.

static const UT_StringHolder& GA_IntrinsicManager::getGlobalName ( GA_GlobalIntrinsic  handle)
static

Find the token associated with the given global handle.

int GA_IntrinsicManager::getLocalEntries ( ) const
inline

Return the number of local handles defined in the manager.

Definition at line 52 of file GA_IntrinsicManager.h.

GA_LocalIntrinsic GA_IntrinsicManager::getLocalHandle ( const UT_StringRef token) const

Mapping between global and local attributes

GA_LocalIntrinsic GA_IntrinsicManager::getLocalHandle ( GA_GlobalIntrinsic  ghandle) const

Mapping between global and local attributes

const UT_StringHolder& GA_IntrinsicManager::getName ( GA_LocalIntrinsic  handle) const
inline

Look up an attribute name from the given handle.

Definition at line 71 of file GA_IntrinsicManager.h.

const UT_Options* GA_IntrinsicManager::getOptions ( const UT_StringRef name) const
inline

Get the attribute options (passed in during registration)

Definition at line 116 of file GA_IntrinsicManager.h.

const UT_Options* GA_IntrinsicManager::getOptions ( GA_LocalIntrinsic  handle) const
inline

Get the attribute options (passed in during registration)

Definition at line 118 of file GA_IntrinsicManager.h.

bool GA_IntrinsicManager::getReadOnly ( const UT_StringRef name) const
inline

Get the attribute storage (passed in during registration)

Definition at line 92 of file GA_IntrinsicManager.h.

bool GA_IntrinsicManager::getReadOnly ( GA_LocalIntrinsic  handle) const
inline

Get the attribute storage (passed in during registration)

Definition at line 94 of file GA_IntrinsicManager.h.

GA_StorageClass GA_IntrinsicManager::getStorage ( const UT_StringRef name) const
inline

Get the attribute storage (passed in during registration)

Definition at line 80 of file GA_IntrinsicManager.h.

GA_StorageClass GA_IntrinsicManager::getStorage ( GA_LocalIntrinsic  handle) const
inline

Get the attribute storage (passed in during registration)

Definition at line 82 of file GA_IntrinsicManager.h.

int GA_IntrinsicManager::getUserId ( const UT_StringRef name) const
inline

Get the attribute's user id (passed in during registration)

Definition at line 104 of file GA_IntrinsicManager.h.

int GA_IntrinsicManager::getUserId ( GA_LocalIntrinsic  handle) const
inline

Get the attribute's user id (passed in during registration)

Definition at line 106 of file GA_IntrinsicManager.h.

static GA_GlobalIntrinsic GA_IntrinsicManager::registerGlobalHandle ( const UT_StringHolder token)
static

Register a global token (returns the existing handle if it's found)

Friends And Related Function Documentation

friend class GA_PrimitiveDefinition
friend

Definition at line 369 of file GA_IntrinsicManager.h.

friend class GA_PrimitiveFactory
friend

Definition at line 368 of file GA_IntrinsicManager.h.

friend class Registrar
friend

Definition at line 370 of file GA_IntrinsicManager.h.


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