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

#include <GA_ATIStringArray.h>

+ Inheritance diagram for GA_ATIStringArray:

Public Member Functions

 GA_ATIStringArray (const GA_AttributeType &type, const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, int tuple_size)
 
 ~GA_ATIStringArray () override
 
const GA_AIFSharedStringArraygetAIFSharedStringArray () const override
 Return the attribute's shared string array interface or NULL. More...
 
const GA_AIFJSONgetAIFJSON () const override
 
void getString (UT_StringArray &strings, GA_Offset offset) const
 
void getString (UT_Array< UT_StringHolder > &strings, GA_Offset offset) const
 
void getStringIndex (UT_Array< GA_StringIndexType > &indices, GA_Offset offset) const
 
void setString (GA_Offset offset, const UT_StringArray &strings)
 
void setString (GA_Offset offset, const UT_Array< UT_StringHolder > &strings)
 
void setStringIndex (GA_Offset offset, const UT_Array< GA_StringIndexType > &indices)
 
- Public Member Functions inherited from GA_ATIBlobArray
 GA_ATIBlobArray (const GA_AttributeType &type, const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, int tuple_size)
 
 ~GA_ATIBlobArray () override
 
int64 getMemoryUsage (bool inclusive) const override
 Report approximate memory usage. More...
 
void countMemory (UT_MemoryCounter &counter, bool inclusive) const override
 
void reconstructElementBlock (GA_Offset offset, GA_Offset nelements) override
 
exint findMaximumArrayLength () const
 
int getTupleSize () const
 Get the tuple size. More...
 
bool setTupleSize (int size)
 
int entries () const
 Return the entries in the blob container. More...
 
GA_BlobIndex getMaximumIndex () const
 
int capacity () const
 Return the capacity of the blob container. More...
 
void getBlobIndex (UT_Array< GA_BlobIndex > &indices, GA_Offset offset) const
 Look up a blob handle by offset. More...
 
bool setBlobIndex (const UT_Array< GA_BlobIndex > &indices, GA_Offset offset)
 Store a new blob_index at the given offset. More...
 
void getBlob (UT_Array< GA_BlobRef > &blobs, GA_Offset offset) const
 Get the blob associated with a given offset into the array. More...
 
bool setBlob (const UT_Array< GA_BlobRef > &blobs, GA_Offset offset)
 Store a new blob at the given offset. More...
 
bool replaceBlob (GA_BlobIndex handle, const GA_BlobRef &blob)
 Replace a blob in the blob container with a new blob value. More...
 
GA_BlobRef lookupBlob (GA_BlobIndex handle) const
 Look up a blob given its handle. More...
 
GA_BlobRef getOrderedBlob (exint idx) const
 Lookup a blob given an ordered index. More...
 
void compactStorage () override
 
fpreal getStorageOccupancy ()
 Get a measure of the vacancy entropy of the storage container. This. More...
 
WriteConcurrence getSupportedWriteConcurrence () const override
 
const GA_AIFBlobArraygetAIFBlobArray () const override
 Return the attribute's blob array interface or NULL. More...
 
const GA_AIFMergegetAIFMerge () const override
 Return the attribute's merge interface or NULL. More...
 
const GA_AIFComparegetAIFCompare () const override
 Return the attribute's comparison interface or NULL. More...
 
const GA_AIFCopyDatagetAIFCopyData () const override
 Return the attribute's copy interface or NULL. More...
 
const GA_AIFInterp * getAIFInterp () const override
 Return the attribute's interpolation interface or NULL. More...
 
bool jsonSave (UT_JSONWriter &w, const GA_SaveMap &s, const char *blobtoken="data") const
 
bool jsonLoad (UT_JSONParser &p, const GA_BlobDataLoader &blobloader, const GA_LoadMap &load, const char *blobtoken="data")
 
int extractBlobs (UT_Array< GA_BlobRef > &blobs, UT_IntArray &handles) const
 
bool setArraySize (GA_Offset new_size) override
 Grow or shrink the array size. More...
 
virtual exint arraySize (GA_Offset item) const
 Return the array size for a given offset. More...
 
void tryCompressAllPages (GA_Offset start_offset=GA_Offset(0), GA_Offset end_offset=GA_INVALID_OFFSET) override
 Try to compress data pages. More...
 
void hardenAllPages (GA_Offset start_offset=GA_Offset(0), GA_Offset end_offset=GA_INVALID_OFFSET) override
 Harden data pages. More...
 
bool matchesStorage (const GA_Attribute *that) const override
 
void replace (const GA_Attribute &src) override
 
void defragment (const GA_Defragment &defrag) override
 
- Public Member Functions inherited from GA_Attribute
 GA_Attribute (const GA_AttributeType &type, const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name)
 
virtual ~GA_Attribute ()
 
const GA_AttributeTypegetType () const
 
const GA_IndexMapgetIndexMap () const
 
const GA_DetailgetDetail () const
 
GA_DetailgetDetail ()
 
GA_AttributeOwner getOwner () const
 
GA_AttributeScope getScope () const
 
SYS_FORCE_INLINE GA_TypeInfo getTypeInfo () const
 
SYS_FORCE_INLINE void setTypeInfo (GA_TypeInfo type)
 
bool shouldInterpretAsTexCoord (bool allow_float2=false) const
 
GA_StorageClass getStorageClass () const
 Returns the approximate type of the attribute. More...
 
int getTupleSize () const
 Size of the AIFTuple, if it exists. If it doesn't, 1. More...
 
const UT_StringHoldergetName () const
 
const UT_StringHoldergetFullName () const
 
SYS_FORCE_INLINE GA_DataId getDataId () const
 
SYS_FORCE_INLINE void assignNewDataId ()
 
SYS_FORCE_INLINE void bumpDataId ()
 
SYS_FORCE_INLINE void clearDataId ()
 
SYS_FORCE_INLINE void cloneDataId (const GA_Attribute &src, bool allow_clear=false)
 
SYS_FORCE_INLINE void cloneOrBumpDataId (const GA_Attribute &src, bool allow_clear=false)
 NOTE: Just call cloneDataId(src). More...
 
virtual const GA_AIFDeltagetAIFDelta () const
 Return the attribute's delta interface or NULL. More...
 
virtual const GA_AIFTuplegetAIFTuple () const
 Return the attribute's tuple interface or NULL. More...
 
virtual const GA_AIFMathgetAIFMath () const
 Return the attribute's math interface or NULL. More...
 
virtual const GA_AIFBlobgetAIFBlob () const
 Return the attribute's blob interface or NULL. More...
 
virtual const GA_AIFStringTuplegetAIFStringTuple () const
 Return the attribute's string tuple interface or NULL. More...
 
virtual const
GA_AIFSharedStringTuple
getAIFSharedStringTuple () const
 Return the attribute's shared string tuple interface or NULL. More...
 
virtual const
GA_AIFSharedDictTuple
getAIFSharedDictTuple () const
 Return the attribute's shared options tuple interface or NULL. More...
 
virtual const
GA_AIFSharedDictArray
getAIFSharedDictArray () const
 Return the attribute's shared options tuple interface or NULL. More...
 
virtual const GA_AIFIndexPairgetAIFIndexPair () const
 Return the attribute's index pair interface or NULL. More...
 
virtual const GA_AIFBlindDatagetAIFBlindData () const
 Return the attribute's blind data interface or NULL. More...
 
virtual const GA_AIFEditgetAIFEdit () const
 Return the attribute's edit interface or NULL. More...
 
virtual const GA_AIFNumericArraygetAIFNumericArray () const
 Return the attribute's arraydata interface or NULL. More...
 
virtual const GA_AIFStatgetAIFStat () const
 
template<typename T >
const TgetAIF () const
 Generic method for getting an AIF by type. More...
 
const GA_AttributeOptionsgetOptions () const
 
GA_AttributeOptionsgetOptions ()
 
void setNonTransforming (bool val)
 
bool needsTransform (bool include_P=true) const
 
bool isDetached () const
 
void mergeOptions (const GA_AttributeOptions &src)
 Merge the options passed in with the options in the attribute. More...
 
bool importOption (const char *name, int &v) const
 
bool importOption (const char *name, bool &v) const
 
bool importOption (const char *name, fpreal32 &v) const
 
bool importOption (const char *name, fpreal64 &v) const
 
bool importOption (const char *name, UT_String &v) const
 
void setTailInitialization (bool onoff)
 
bool isTailInitialization () const
 Check whether the attribute is set to tail initialization. More...
 
void reconstructElement (GA_Offset offset)
 
virtual void batchDeletion ()
 
GA_Attributeclone (const GA_IndexMap &index_map, const UT_StringHolder &name, bool clone_options) const
 
bool jsonSaveDefinition (UT_JSONWriter &w) const
 Save the GA_Attribute-Definition section. More...
 
virtual int getSaveVersion () const
 
virtual bool debugValidateArrayCapacity (GA_Offset sz) const
 Debug validation of allocated array size. More...
 
virtual void copyNonStorageMetadata (const GA_Attribute *that)
 
GA_AttributeProxyHandle getProxy ()
 
GA_ConstAttributeProxyHandle getProxy () const
 
void setExportName (const char *external_name)
 
bool hasExportName () const
 
std::string getExportName () const
 
GA_CEAttributegetCEAttribute (GA_StorageClass storage, int &tuplesize, bool isarray, bool read, bool write)
 
GA_CEAttributegetCEAttribute (GA_StorageClass storage, GA_Precision precision, int &tuplesize, bool isarray, bool read, bool write)
 
void flushCEWriteCaches (bool clearwriteback=true)
 
bool hasPendingCEWriteBack () const
 
void flushCECaches ()
 Remove all CE Caches, copying back any marked as written to. More...
 
bool isActivelyStreamed () const
 
void setActivelyStreamed (bool isstreaming)
 
bool existedPriorToStream () const
 
void setExistedPriorToStream (bool preexisted)
 
virtual bool copy (GA_Offset desti, GA_Offset srci)
 
virtual bool copy (GA_Offset desti, const GA_Attribute &src, GA_Offset srci)
 
virtual bool copy (const GA_Range &destrange, const GA_Range &srcrange)
 
virtual bool copy (const GA_Range &destrange, const GA_Attribute &src, const GA_Range &srcrange)
 
virtual bool fill (const GA_Range &destrange, GA_Offset srci)
 
virtual bool fill (const GA_Range &destrange, const GA_Attribute &src, GA_Offset srci)
 
bool hasFlag (AttribFlag flag) const
 
void setFlag (AttribFlag flag, bool onoff)
 

Static Public Member Functions

static void registerType ()
 
static SYS_FORCE_INLINE const
UT_StringHolder
getTypeName ()
 
static SYS_FORCE_INLINE const
GA_AttributeType
getType ()
 
static SYS_FORCE_INLINE bool isType (const GA_Attribute *attrib)
 
static SYS_FORCE_INLINE
GA_ATIStringArray
cast (GA_Attribute *attrib)
 
static SYS_FORCE_INLINE const
GA_ATIStringArray
cast (const GA_Attribute *attrib)
 
static GA_Attributecreate (const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, const GA_AttributeOptions *attribute_options=NULL)
 
static GA_Attributecreate (const GA_IndexMap &index_map, const UT_StringHolder &name)
 
- Static Public Member Functions inherited from GA_ATIBlobArray
static void registerType ()
 
static SYS_FORCE_INLINE const
UT_StringHolder
getTypeName ()
 
static SYS_FORCE_INLINE const
GA_AttributeType
getType ()
 
static SYS_FORCE_INLINE bool isType (const GA_Attribute *attrib)
 
static SYS_FORCE_INLINE
GA_ATIBlobArray
cast (GA_Attribute *attrib)
 
static SYS_FORCE_INLINE const
GA_ATIBlobArray
cast (const GA_Attribute *attrib)
 
static GA_Attributecreate (const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, const GA_AttributeOptions *attribute_options=NULL)
 
static GA_Attributecreate (const GA_IndexMap &index_map, const UT_StringHolder &name)
 
- Static Public Member Functions inherited from GA_Attribute
static bool jsonLoadDefinition (UT_JSONParser &p, GA_AttributeScope &scope, UT_WorkBuffer &type, UT_WorkBuffer &name, int64 &version, GA_AttributeOptions &options)
 Load the GA_Attribute-Definition section. More...
 
static GA_DataId nextDataId ()
 

Protected Member Functions

GA_AttributedoClone (const GA_IndexMap &index_map, const UT_StringHolder &name) const override
 Create a new ATIBlob attribute. Sub-classes must implement this. More...
 
- Protected Member Functions inherited from GA_ATIBlobArray
bool needDestruction () const override
 
void destructElement (GA_Offset offset) override
 Callback method to destruct an offset. More...
 
void mergeDestroyDestination (const GA_MergeMap &map, GA_Attribute *dattrib) const
 
GA_AttributemergeAddDestination (const GA_MergeMap &map, GA_Attribute *dattrib) const
 Base class implementation of GA_AIFMerge::addDestination() More...
 
void mergeGrowArray (const GA_MergeMap &map, const GA_ATIBlobArray &s)
 Base class implementation of GA_AIFMerge::growArray() More...
 
bool mergeAppendData (const GA_MergeMap &map, const GA_Attribute *sattrib)
 Base class implementation of GA_AIFMerge::copyArray() More...
 
bool copyData (GA_Offset di, const GA_ATIBlobArray *s, GA_Offset si)
 
bool copyData (const GA_Range &di, const GA_ATIBlobArray *s, const GA_Range &si)
 
GA_BlobIndex addBlobReference (const GA_BlobRef &blob)
 
void delBlobReference (GA_BlobIndex handle)
 
virtual bool isEqual (GA_Offset offset, const GA_ATIBlobArray &b, GA_Offset b_offset) const
 
virtual bool isEqual (const GA_Range &range, const GA_ATIBlobArray &b, const GA_Range &b_range) const
 
- Protected Member Functions inherited from GA_Attribute
int64 getBaseMemoryUsage () const
 
void setDetached (bool detached)
 Only called by GA_AttributeSet and GA_ElementGroup. More...
 

Additional Inherited Members

- Public Types inherited from GA_Attribute
enum  WriteConcurrence { WRITE_CONCURRENCE_NONE, WRITE_CONCURRENCE_PAGE, WRITE_CONCURRENCE_ELEMENT }
 
enum  AttribFlag { FLAG_TAIL_INITIALIZE = 1, FLAG_STREAM_ACTIVE = 2, FLAG_STREAM_NOPREEXIST = 4 }
 
- Protected Attributes inherited from GA_ATIBlobArray
GA_ArrayDataArray myHandles
 
GA_BlobContainer myBlobs
 Blob references. This is protected for convenience to sub-classes. More...
 

Detailed Description

Definition at line 41 of file GA_ATIStringArray.h.

Constructor & Destructor Documentation

GA_ATIStringArray::GA_ATIStringArray ( const GA_AttributeType type,
const GA_IndexMap index_map,
GA_AttributeScope  scope,
const UT_StringHolder name,
int  tuple_size 
)
GA_ATIStringArray::~GA_ATIStringArray ( )
override

Member Function Documentation

static SYS_FORCE_INLINE GA_ATIStringArray* GA_ATIStringArray::cast ( GA_Attribute attrib)
inlinestatic

Definition at line 58 of file GA_ATIStringArray.h.

static SYS_FORCE_INLINE const GA_ATIStringArray* GA_ATIStringArray::cast ( const GA_Attribute attrib)
inlinestatic

Definition at line 65 of file GA_ATIStringArray.h.

static GA_Attribute* GA_ATIStringArray::create ( const GA_IndexMap index_map,
GA_AttributeScope  scope,
const UT_StringHolder name,
const GA_AttributeOptions attribute_options = NULL 
)
static
static GA_Attribute* GA_ATIStringArray::create ( const GA_IndexMap index_map,
const UT_StringHolder name 
)
inlinestatic

Definition at line 76 of file GA_ATIStringArray.h.

GA_Attribute* GA_ATIStringArray::doClone ( const GA_IndexMap index_map,
const UT_StringHolder name 
) const
overrideprotectedvirtual

Create a new ATIBlob attribute. Sub-classes must implement this.

Reimplemented from GA_ATIBlobArray.

const GA_AIFJSON* GA_ATIStringArray::getAIFJSON ( ) const
inlineoverridevirtual

JSON Schema: GA_ATIStringArray

{
"name" : "GA_ATIStringArray",
"description" : "An tuple array of indexed strings",
"type" : "orderedmap",
"properties": {
"storage": {
"type" : "string",
"description" : "Tuple storage",
"enum" : [ "int8", "int16", "int32", "int64" ],
},
"strings": {
"type" : { "$ref":"GA_BlobData", },
"description" : "Array of strings used in the attribute",
},
"indices": {
"type" : {"$ref":"GA_DataArrayTuple"},
"description" : "Int index for each element of the array",
},
},
}
See Also
JSON_FileFormat

Reimplemented from GA_Attribute.

Definition at line 115 of file GA_ATIStringArray.h.

const GA_AIFSharedStringArray* GA_ATIStringArray::getAIFSharedStringArray ( ) const
inlineoverridevirtual

Return the attribute's shared string array interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 88 of file GA_ATIStringArray.h.

void GA_ATIStringArray::getString ( UT_StringArray strings,
GA_Offset  offset 
) const

Get a string

void GA_ATIStringArray::getString ( UT_Array< UT_StringHolder > &  strings,
GA_Offset  offset 
) const

Get a string

void GA_ATIStringArray::getStringIndex ( UT_Array< GA_StringIndexType > &  indices,
GA_Offset  offset 
) const

Get a string

static SYS_FORCE_INLINE const GA_AttributeType& GA_ATIStringArray::getType ( )
inlinestatic

Definition at line 50 of file GA_ATIStringArray.h.

static SYS_FORCE_INLINE const UT_StringHolder& GA_ATIStringArray::getTypeName ( )
inlinestatic

Definition at line 47 of file GA_ATIStringArray.h.

static SYS_FORCE_INLINE bool GA_ATIStringArray::isType ( const GA_Attribute attrib)
inlinestatic

Definition at line 53 of file GA_ATIStringArray.h.

static void GA_ATIStringArray::registerType ( )
static
void GA_ATIStringArray::setString ( GA_Offset  offset,
const UT_StringArray strings 
)

Set a string

void GA_ATIStringArray::setString ( GA_Offset  offset,
const UT_Array< UT_StringHolder > &  strings 
)

Set a string

void GA_ATIStringArray::setStringIndex ( GA_Offset  offset,
const UT_Array< GA_StringIndexType > &  indices 
)

Set a string


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