#include <GA_ATIDictArray.h>

Inheritance diagram for GA_ATIDictArray:

Public Member Functions
	GA_ATIDictArray (const GA_AttributeType &type, const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, int tuple_size)

	~GA_ATIDictArray () override

const GA_AIFSharedDictArray *	getAIFSharedDictArray () const override
	Return the attribute's shared options tuple interface or NULL. More...

const GA_AIFJSON *	getAIFJSON () const override


void	getDict (UT_Array< UT_OptionsHolder > &strings, GA_Offset offset) const

void	getDictIndex (UT_Array< GA_DictIndexType > &indices, GA_Offset offset) const


void	setDict (GA_Offset offset, const UT_Array< UT_OptionsHolder > &strings)

void	setDictIndex (GA_Offset offset, const UT_Array< GA_DictIndexType > &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_AIFBlobArray *	getAIFBlobArray () const override
	Return the attribute's blob array interface or NULL. More...

const GA_AIFMerge *	getAIFMerge () const override
	Return the attribute's merge interface or NULL. More...

const GA_AIFCompare *	getAIFCompare () const override
	Return the attribute's comparison interface or NULL. More...

const GA_AIFCopyData *	getAIFCopyData () 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 ()

SYS_FORCE_INLINE const GA_AttributeType &	getType () const

SYS_FORCE_INLINE const GA_IndexMap &	getIndexMap () const

SYS_FORCE_INLINE const GA_Detail &	getDetail () const

SYS_FORCE_INLINE GA_Detail &	getDetail ()

SYS_FORCE_INLINE GA_AttributeOwner	getOwner () const

SYS_FORCE_INLINE GA_AttributeScope	getScope () const

SYS_FORCE_INLINE bool	isGroup () 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...

SYS_FORCE_INLINE const UT_StringHolder &	getName () const

SYS_FORCE_INLINE const UT_StringHolder &	getFullName () 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_AIFDelta *	getAIFDelta () const
	Return the attribute's delta interface or NULL. More...

virtual const GA_AIFTuple *	getAIFTuple () const
	Return the attribute's tuple interface or NULL. More...

virtual const GA_AIFMath *	getAIFMath () const
	Return the attribute's math interface or NULL. More...

virtual const GA_AIFBlob *	getAIFBlob () const
	Return the attribute's blob interface or NULL. More...

virtual const GA_AIFStringTuple *	getAIFStringTuple () 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_AIFSharedStringArray *	getAIFSharedStringArray () const
	Return the attribute's shared string array interface or NULL. More...

virtual const GA_AIFSharedDictTuple *	getAIFSharedDictTuple () const
	Return the attribute's shared options tuple interface or NULL. More...

virtual const GA_AIFIndexPair *	getAIFIndexPair () const
	Return the attribute's index pair interface or NULL. More...

virtual const GA_AIFBlindData *	getAIFBlindData () const
	Return the attribute's blind data interface or NULL. More...

virtual const GA_AIFEdit *	getAIFEdit () const
	Return the attribute's edit interface or NULL. More...

virtual const GA_AIFNumericArray *	getAIFNumericArray () const
	Return the attribute's arraydata interface or NULL. More...

virtual const GA_AIFStat *	getAIFStat () const

template<typename T >
const T *	getAIF () const
	Generic method for getting an AIF by type. More...

const GA_AttributeOptions &	getOptions () const

GA_AttributeOptions &	getOptions ()

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_Attribute *	clone (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)

SYS_FORCE_INLINE GA_AttributeProxyHandle	getProxy ()

SYS_FORCE_INLINE GA_ConstAttributeProxyHandle	getProxy () const

void	setExportName (const char *external_name)

bool	hasExportName () const

std::string	getExportName () const

GA_CEAttribute *	getCEAttribute (GA_StorageClass storage, int &tuplesize, bool isarray, bool read, bool write)

GA_CEAttribute *	getCEAttribute (GA_StorageClass storage, GA_Precision precision, int &tuplesize, bool isarray, bool read, bool write)

void	setCEAttribute (GA_CEAttribute *ceattrib, bool leave_on_gpupu=false)

void	flushCEWriteCaches (bool clearwriteback=true)

bool	hasPendingCEWriteBack () const

void	flushCECaches ()
	Remove all CE Caches, copying back any marked as written to. More...

void	stealCEAttribute (const GA_Attribute &src)

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_ATIDictArray *	cast (GA_Attribute *attrib)

static SYS_FORCE_INLINE const GA_ATIDictArray *	cast (const GA_Attribute *attrib)

static GA_Attribute *	create (const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, const GA_AttributeOptions *attribute_options=nullptr)

static GA_Attribute *	create (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_Attribute *	create (const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, const GA_AttributeOptions *attribute_options=NULL)

static GA_Attribute *	create (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_Attribute *	doClone (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_Attribute *	mergeAddDestination (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)

bool	fillData (const GA_Range &di, const GA_ATIBlobArray *s, GA_Offset 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 }

Static Protected Member Functions inherited from GA_Attribute
static bool	checkGlobalOverwrite (const GA_MergeMap &map, const GA_Attribute *attrib)

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 38 of file GA_ATIDictArray.h.

Constructor & Destructor Documentation

GA_ATIDictArray::GA_ATIDictArray	(	const GA_AttributeType &	type,
		const GA_IndexMap &	index_map,
		GA_AttributeScope	scope,
		const UT_StringHolder &	name,
		int	tuple_size
	)

GA_ATIDictArray::~GA_ATIDictArray ( )

override

Member Function Documentation

static SYS_FORCE_INLINE GA_ATIDictArray* GA_ATIDictArray::cast ( GA_Attribute * attrib )

inlinestatic

Definition at line 55 of file GA_ATIDictArray.h.

static SYS_FORCE_INLINE const GA_ATIDictArray* GA_ATIDictArray::cast ( const GA_Attribute * attrib )

inlinestatic

Definition at line 62 of file GA_ATIDictArray.h.

static GA_Attribute* GA_ATIDictArray::create	(	const GA_IndexMap &	index_map,
		GA_AttributeScope	scope,
		const UT_StringHolder &	name,
		const GA_AttributeOptions *	attribute_options = `nullptr`
	)

static

static GA_Attribute* GA_ATIDictArray::create	(	const GA_IndexMap &	index_map,
		const UT_StringHolder &	name
	)

inlinestatic

Definition at line 74 of file GA_ATIDictArray.h.

GA_Attribute* GA_ATIDictArray::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_ATIDictArray::getAIFJSON ( ) const

inlineoverridevirtual

JSON Schema: GA_ATIDictArray

{
    "name"          : "GA_ATIDictArray",
    "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 113 of file GA_ATIDictArray.h.

const GA_AIFSharedDictArray* GA_ATIDictArray::getAIFSharedDictArray ( ) const

inlineoverridevirtual

Return the attribute's shared options tuple interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 86 of file GA_ATIDictArray.h.

void GA_ATIDictArray::getDict	(	UT_Array< UT_OptionsHolder > &	strings,
		GA_Offset	offset
	)		const

Get a string

void GA_ATIDictArray::getDictIndex	(	UT_Array< GA_DictIndexType > &	indices,
		GA_Offset	offset
	)		const

Get a string

static SYS_FORCE_INLINE const GA_AttributeType& GA_ATIDictArray::getType ( )

inlinestatic

Definition at line 47 of file GA_ATIDictArray.h.

static SYS_FORCE_INLINE const UT_StringHolder& GA_ATIDictArray::getTypeName ( )

inlinestatic

Definition at line 44 of file GA_ATIDictArray.h.

static SYS_FORCE_INLINE bool GA_ATIDictArray::isType ( const GA_Attribute * attrib )

inlinestatic

Definition at line 50 of file GA_ATIDictArray.h.

static void GA_ATIDictArray::registerType ( )

static

void GA_ATIDictArray::setDict	(	GA_Offset	offset,
		const UT_Array< UT_OptionsHolder > &	strings
	)

Set a string

void GA_ATIDictArray::setDictIndex	(	GA_Offset	offset,
		const UT_Array< GA_DictIndexType > &	indices
	)

Set a string

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

GA/GA_ATIDictArray.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

JSON Schema: GA_ATIDictArray