#include <GA_ATINumericArray.h>

Inheritance diagram for GA_ATINumericArray:

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

	~GA_ATINumericArray () override

int64	getMemoryUsage (bool inclusive) const override
	Report memory used. More...

void	countMemory (UT_MemoryCounter &counter, bool inclusive) const override

void	reconstructElementBlock (GA_Offset offset, GA_Offset nelements) override

WriteConcurrence	getSupportedWriteConcurrence () const override

const GA_AIFCopyData *	getAIFCopyData () const override
	Return the attribute's copy interface or NULL. More...

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

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

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

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

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

const GA_AIFInterp *	getAIFInterp () const override
	Return the attribute's interpolation interface or NULL. More...

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

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

const GA_AIFJSON *	getAIFJSON () const override

GA_Storage	getDataStorage () const

bool	setDataStorage (GA_Storage storage)

int	getDataTupleSize () const
	The size of the data tuple. More...

bool	setArraySize (GA_Offset new_size) override
	Grow or shrink the array size. 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_AIFBlob *	getAIFBlob () const
	Return the attribute's blob interface or NULL. More...

virtual const GA_AIFBlobArray *	getAIFBlobArray () const
	Return the attribute's blob array 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_AIFSharedDictArray *	getAIFSharedDictArray () const
	Return the attribute's shared options tuple interface or NULL. More...

virtual const GA_AIFBlindData *	getAIFBlindData () const
	Return the attribute's blind data 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

virtual bool	needDestruction () const
	Methods which can be overridden from GA_Attribute. More...

virtual void	destructElement (GA_Offset offset)
	Callback invoked if needsDestruction() returns true. More...

void	setTailInitialization (bool onoff)

bool	isTailInitialization () const
	Check whether the attribute is set to tail initialization. More...

void	reconstructElement (GA_Offset offset)

virtual void	compactStorage ()

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_gpu=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_ATINumericArray *	cast (GA_Attribute *attrib)

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

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
bool	setDataTupleSize (int size)


bool	copyData (GA_Offset di, const GA_ATINumericArray &src, GA_Offset si)

bool	copyData (const GA_Range &di, const GA_ATINumericArray &src, const GA_Range &si)


bool	isAlmostEqual (GA_Offset di, const GA_ATINumericArray &src, GA_Offset si, int ulps) const

bool	isAlmostEqual (const GA_Range &di, const GA_ATINumericArray &src, const GA_Range &si, int ulps) const


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...

bool	mergeAppendData (const GA_MergeMap &map, const GA_Attribute *sattrib)
	Base class implementation of GA_AIFMerge::copyArray() More...

void	mergeGrowArray (const GA_MergeMap &map, const GA_ATINumericArray &s)

Protected Member Functions inherited from GA_Attribute
int64	getBaseMemoryUsage () const

void	setDetached (bool detached)
	Only called by GA_AttributeSet and GA_ElementGroup. More...

Protected Attributes
GA_ArrayDataArray	myData

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)

Detailed Description

Definition at line 44 of file GA_ATINumericArray.h.

Constructor & Destructor Documentation

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

GA_ATINumericArray::~GA_ATINumericArray ( )

override

Member Function Documentation

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

inlinestatic

Definition at line 61 of file GA_ATINumericArray.h.

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

inlinestatic

Definition at line 68 of file GA_ATINumericArray.h.

bool GA_ATINumericArray::copyData	(	GA_Offset	di,
		const GA_ATINumericArray &	src,
		GA_Offset	si
	)

protected

Copy Data AIF

bool GA_ATINumericArray::copyData	(	const GA_Range &	di,
		const GA_ATINumericArray &	src,
		const GA_Range &	si
	)

protected

Copy Data AIF

void GA_ATINumericArray::countMemory	(	UT_MemoryCounter &	counter,
		bool	inclusive
	)		const

overridevirtual

Count memory usage using a UT_MemoryCounter in order to count shared memory correctly. If inclusive is true, the size of this object is counted, else only memory owned by this object is counted. If this is pointed to by the calling object, inclusive should be true. If this is contained in the calling object, inclusive should be false. (Its memory was already counted in the size of the calling object.)

NOTE: If you're implementing this in a direct subclass of GA_Attribute, call getBaseMemoryUsage() to get the amount of memory in the base class. If in a more distant descendant class, call Base::countMemory(counter, false) to count the memory in Base and above, excluding sizeof(Base).

Implements GA_Attribute.

void GA_ATINumericArray::defragment ( const GA_Defragment & defrag )

overridevirtual

Interface for defragmentation

Implements GA_Attribute.

const GA_AIFCompare* GA_ATINumericArray::getAIFCompare ( ) const

inlineoverridevirtual

Return the attribute's comparison interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 113 of file GA_ATINumericArray.h.

const GA_AIFCopyData* GA_ATINumericArray::getAIFCopyData ( ) const

inlineoverridevirtual

Return the attribute's copy interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 99 of file GA_ATINumericArray.h.

const GA_AIFEdit* GA_ATINumericArray::getAIFEdit ( ) const

inlineoverridevirtual

Return the attribute's edit interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 105 of file GA_ATINumericArray.h.

const GA_AIFIndexPair* GA_ATINumericArray::getAIFIndexPair ( ) const

inlineoverridevirtual

Return the attribute's index pair interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 101 of file GA_ATINumericArray.h.

const GA_AIFInterp* GA_ATINumericArray::getAIFInterp ( ) const

inlineoverridevirtual

Return the attribute's interpolation interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 111 of file GA_ATINumericArray.h.

const GA_AIFJSON* GA_ATINumericArray::getAIFJSON ( ) const

inlineoverridevirtual

JSON Schema: GA_ATINumericArray

{
    "name"          : "GA_ATINumericArray",
    "description"   : "An array of arrays of tuples",
    "type"          : "orderedmap",
    "properties": {
        "size": {
            "type"          : "integer",
            "minimum"       : 1,
            "description"   : "Tuple size",
        },
        "storage": {
            "type"        : "string",
            "description" : "Storage type for values",
            "enum"        : [ "uint8","int8","int16","int32","int64",
                              "fpreal16", "fpreal32", "fpreal64" ],
        },
        "values": {
            "type"        : {"$ref":"GA_DataArrayTuple"},
            "description" : "Array values.",
        },
    },
}

See Also: JSON_FileFormat

Reimplemented from GA_Attribute.

Definition at line 144 of file GA_ATINumericArray.h.

const GA_AIFMath* GA_ATINumericArray::getAIFMath ( ) const

inlineoverridevirtual

Return the attribute's math interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 109 of file GA_ATINumericArray.h.

const GA_AIFMerge* GA_ATINumericArray::getAIFMerge ( ) const

inlineoverridevirtual

Return the attribute's merge interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 103 of file GA_ATINumericArray.h.

const GA_AIFNumericArray* GA_ATINumericArray::getAIFNumericArray ( ) const

inlineoverridevirtual

Return the attribute's arraydata interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 115 of file GA_ATINumericArray.h.

const GA_AIFTuple* GA_ATINumericArray::getAIFTuple ( ) const

inlineoverridevirtual

Return the attribute's tuple interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 107 of file GA_ATINumericArray.h.

GA_Storage GA_ATINumericArray::getDataStorage ( ) const

int GA_ATINumericArray::getDataTupleSize ( ) const

The size of the data tuple.

int64 GA_ATINumericArray::getMemoryUsage ( bool inclusive ) const

overridevirtual

Report memory used.

Implements GA_Attribute.

WriteConcurrence GA_ATINumericArray::getSupportedWriteConcurrence ( ) const

inlineoverridevirtual

Adding entries is thread-safe, so we're only subject to GA_DataArray limitations.

Implements GA_Attribute.

Definition at line 96 of file GA_ATINumericArray.h.

static SYS_FORCE_INLINE const GA_AttributeType& GA_ATINumericArray::getType ( )

inlinestatic

Definition at line 53 of file GA_ATINumericArray.h.

static SYS_FORCE_INLINE const UT_StringHolder& GA_ATINumericArray::getTypeName ( )

inlinestatic

Definition at line 50 of file GA_ATINumericArray.h.

void GA_ATINumericArray::hardenAllPages	(	GA_Offset	start_offset = `GA_Offset(0)`,
		GA_Offset	end_offset = `GA_INVALID_OFFSET`
	)

overridevirtual

Harden data pages.

Implements GA_Attribute.

bool GA_ATINumericArray::isAlmostEqual	(	GA_Offset	di,
		const GA_ATINumericArray &	src,
		GA_Offset	si,
		int	ulps
	)		const

protected

Compare AIF

bool GA_ATINumericArray::isAlmostEqual	(	const GA_Range &	di,
		const GA_ATINumericArray &	src,
		const GA_Range &	si,
		int	ulps
	)		const

protected

Compare AIF

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

inlinestatic

Definition at line 56 of file GA_ATINumericArray.h.

bool GA_ATINumericArray::matchesStorage ( const GA_Attribute * that ) const

inlineoverridevirtual

Returns true iff that is an attribute whose content can be copied from this without any type conversions. This is important to avoid reallocation of an attribute if its storage type, including tuple size, matches the source attribute exactly.

Reimplemented from GA_Attribute.

Definition at line 170 of file GA_ATINumericArray.h.

GA_Attribute* GA_ATINumericArray::mergeAddDestination	(	const GA_MergeMap &	map,
		GA_Attribute *	dattrib
	)		const

protected

Base class implementation of GA_AIFMerge::addDestination()

bool GA_ATINumericArray::mergeAppendData	(	const GA_MergeMap &	map,
		const GA_Attribute *	sattrib
	)

protected

Base class implementation of GA_AIFMerge::copyArray()

void GA_ATINumericArray::mergeDestroyDestination	(	const GA_MergeMap &	map,
		GA_Attribute *	dattrib
	)		const

protected

GA_AIFMerge Base class implementation of GA_AIFMerge::destroyDestination()

void GA_ATINumericArray::mergeGrowArray	(	const GA_MergeMap &	map,
		const GA_ATINumericArray &	s
	)

protected

GA_AIFMerge Base class implementation of GA_AIFMerge::destroyDestination()

void GA_ATINumericArray::reconstructElementBlock	(	GA_Offset	offset,
		GA_Offset	nelements
	)

overridevirtual

When the array size is grown, attributes should initialize the value appropriately. When elements are reused, however, reconstructElementBlock is called. This happens if an element is deleted and then a new element is allocated (using the existing slot)

Implements GA_Attribute.

static void GA_ATINumericArray::registerType ( )

static

void GA_ATINumericArray::replace ( const GA_Attribute & src )

overridevirtual

This replaces the entirety of this attribute's content and non- storage metadata (except the name) with that of the src attribute. matchesStorage(src) should already return true. This is primarily for use by GA_AttributeSet::replace(). NOTE: The internal content sizes may not match exactly if the attribute type may overallocate, but the sizes should be such that any real data will fit in the destination, so be careful and deal with the myTailInitialize flag appropriately if any extra elements aren't equal to the default.

Implements GA_Attribute.

bool GA_ATINumericArray::setArraySize ( GA_Offset new_size )

overridevirtual

Grow or shrink the array size.

Implements GA_Attribute.

bool GA_ATINumericArray::setDataStorage ( GA_Storage storage )

bool GA_ATINumericArray::setDataTupleSize ( int size )

protected

void GA_ATINumericArray::tryCompressAllPages	(	GA_Offset	start_offset = `GA_Offset(0)`,
		GA_Offset	end_offset = `GA_INVALID_OFFSET`
	)

overridevirtual

Try to compress data pages.

Implements GA_Attribute.

Member Data Documentation

GA_ArrayDataArray GA_ATINumericArray::myData

protected

Definition at line 227 of file GA_ATINumericArray.h.

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

GA/GA_ATINumericArray.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

JSON Schema: GA_ATINumericArray

Member Data Documentation