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

#include <GA_ATIString.h>

+ Inheritance diagram for GA_ATIString:

Public Types

typedef GA_PageArray< int32HandleArrayType
 
- Public Types inherited from GA_Attribute
enum  WriteConcurrence { WRITE_CONCURRENCE_NONE, WRITE_CONCURRENCE_PAGE, WRITE_CONCURRENCE_ELEMENT }
 

Public Member Functions

 GA_ATIString (const GA_AttributeType &type, const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, int tuple_size)
 
virtual ~GA_ATIString ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 Report approximate memory usage. More...
 
virtual void countMemory (UT_MemoryCounter &counter, bool inclusive) const
 
virtual void defragment (const GA_Defragment &defrag)
 Interface for defragmentation. More...
 
virtual void reconstructElementBlock (GA_Offset offset, GA_Offset nelements)
 
SYS_FORCE_INLINE int getTupleSize () const
 Get the tuple size. More...
 
exint entries () const
 Return the entries in the string container. More...
 
GA_BlobIndex getMaximumIndex () const
 
exint capacity () const
 Return the capacity of the string container. More...
 
virtual bool loadStringsH9 (UT_IStream &is, UT_IntArray &handlemap)
 
virtual void loadStringsFinishH9 (const UT_IntArray &handlemap)
 
virtual bool saveStringsH9 (std::ostream &os, int binary, UT_IntArray &handlemap) const
 
bool setTupleSize (int tuplesize)
 Grow or shrink the tuple size. More...
 
virtual void compactStorage ()
 
fpreal getStorageOccupancy ()
 Get a measure of the vacancy entropy of the storage container. This. More...
 
virtual WriteConcurrence getSupportedWriteConcurrence () const
 
virtual const GA_AIFMergegetAIFMerge () const
 Return the attribute's merge interface or NULL. More...
 
virtual const GA_AIFComparegetAIFCompare () const
 Return the attribute's comparison interface or NULL. More...
 
virtual const GA_AIFCopyDatagetAIFCopyData () const
 Return the attribute's copy interface or NULL. More...
 
virtual const GA_AIFInterp * getAIFInterp () const
 Return the attribute's interpolation interface or NULL. More...
 
virtual const
GA_AIFSharedStringTuple
getAIFSharedStringTuple () const
 Return the attribute's shared string tuple interface or NULL. More...
 
virtual const GA_AIFStringTuplegetAIFStringTuple () const
 Return the attribute's string tuple interface or NULL. More...
 
virtual const GA_AIFJSONgetAIFJSON () const
 
virtual bool debugValidateArrayCapacity (GA_Offset sz) const
 Debug code. More...
 
const char * lookupString (GA_StringIndexType handle) const
 
const char * lookupOrderedString (exint handle) const
 
GA_StringIndexType lookupHandle (const UT_StringHolder &s) const
 
GA_StringIndexType validateHandle (GA_StringIndexType h) const
 
bool replaceString (GA_StringIndexType handle, const UT_StringHolder &new_string)
 
bool jsonSave (UT_JSONWriter &w, const GA_SaveMap &s, const char *token) const
 
bool jsonLoad (UT_JSONParser &p, const GA_LoadMap &load, const char *token)
 
bool jsonLoadStrings (UT_JSONParser &p, const GA_LoadMap &lmap, UT_StringArray &strings)
 
virtual bool setArraySize (GA_Offset new_size)
 
virtual void tryCompressAllPages (GA_Offset start_offset=GA_Offset(0), GA_Offset end_offset=GA_INVALID_OFFSET)
 
virtual void hardenAllPages (GA_Offset start_offset=GA_Offset(0), GA_Offset end_offset=GA_INVALID_OFFSET)
 
virtual bool matchesStorage (const GA_Attribute *that) const
 
virtual void replace (const GA_Attribute &src)
 
bool validate () const
 Validates the internal structure for debugging purposes. More...
 
const UT_StringHoldergetString (GA_Offset offset, int component=0) const
 
SYS_FORCE_INLINE GA_StringIndexType getStringIndex (GA_Offset offset, int component=0) const
 
void setString (GA_Offset offset, const UT_StringHolder &str, int component=0)
 
void setStringIndex (GA_Offset offset, GA_StringIndexType i, int component=0)
 
void setStringIndex (const GA_Range &dst_range, GA_StringIndexType i, int component=0)
 
exint extractStrings (UT_StringArray &strings, UT_IntArray &handles) const
 
exint extractStrings (UT_StringArray &strings, UT_IntArray &handles, exint maxstrings) const
 
virtual bool copy (GA_Offset desti, GA_Offset srci) final
 
virtual bool copy (GA_Offset desti, const GA_Attribute &src, GA_Offset srci) final
 
bool copy (GA_Offset desti, const GA_ATIString &src, GA_Offset srci)
 
virtual bool copy (const GA_Range &destrange, const GA_Range &srcrange) final
 
virtual bool copy (const GA_Range &destrange, const GA_Attribute &src, const GA_Range &srcrange) final
 
bool copy (const GA_Range &destrange, const GA_ATIString &src, const GA_Range &srcrange)
 
virtual bool fill (const GA_Range &destrange, GA_Offset srci) final
 
virtual bool fill (const GA_Range &destrange, const GA_Attribute &src, GA_Offset srci) final
 
bool fill (const GA_Range &destrange, const GA_ATIString &src, GA_Offset srci)
 
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_ATIString &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 isEqual (GA_Offset offset, const GA_ATIString &b, GA_Offset b_offset) const
 
bool isEqual (const GA_Range &range, const GA_ATIString &b, const GA_Range &b_range) const
 
- 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_AIFBlobArraygetAIFBlobArray () const
 Return the attribute's blob array interface or NULL. More...
 
virtual const
GA_AIFSharedStringArray
getAIFSharedStringArray () const
 Return the attribute's shared string array 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 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)
 
void flushCEWriteCaches (bool clearwriteback=true)
 
bool hasPendingCEWriteBack () const
 
void flushCECaches ()
 Remove all CE Caches, copying back any marked as written to. More...
 

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_ATIString
cast (GA_Attribute *attrib)
 
static SYS_FORCE_INLINE const
GA_ATIString
cast (const GA_Attribute *attrib)
 
static GA_Attributecreate (const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name, int tuple_size, const GA_AttributeOptions *attribute_options=nullptr)
 
static GA_Attributecreate (const GA_IndexMap &index_map, const UT_StringHolder &name, int tuple_size)
 
- 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

virtual bool needDestruction () const
 
virtual void destructElement (GA_Offset offset)
 Callback method to destruct an offset. More...
 
virtual GA_AttributedoClone (const GA_IndexMap &index_map, const UT_StringHolder &name) const
 Create a new attribute of this type. More...
 
- 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

HandleArrayType myHandles
 Array of handles. The default value is -1. More...
 
UT_IndexedHashSet
< UT_StringHolder
myStrings
 String references. More...
 

Detailed Description

Definition at line 44 of file GA_ATIString.h.

Member Typedef Documentation

Definition at line 392 of file GA_ATIString.h.

Constructor & Destructor Documentation

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

Member Function Documentation

exint GA_ATIString::capacity ( ) const
inline

Return the capacity of the string container.

Definition at line 121 of file GA_ATIString.h.

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

Definition at line 63 of file GA_ATIString.h.

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

Definition at line 70 of file GA_ATIString.h.

virtual void GA_ATIString::compactStorage ( )
virtual

This method will "compact" the attribute container, possibly changing all the handles in the attribute data.

Reimplemented from GA_Attribute.

virtual bool GA_ATIString::copy ( GA_Offset  desti,
GA_Offset  srci 
)
inlinefinalvirtual

Copy attribute values for a single element.

Reimplemented from GA_Attribute.

Definition at line 307 of file GA_ATIString.h.

virtual bool GA_ATIString::copy ( GA_Offset  desti,
const GA_Attribute src,
GA_Offset  srci 
)
inlinefinalvirtual

Copy attribute values for a single element.

Reimplemented from GA_Attribute.

Definition at line 312 of file GA_ATIString.h.

bool GA_ATIString::copy ( GA_Offset  desti,
const GA_ATIString src,
GA_Offset  srci 
)
inline

Copy attribute values for a single element.

Definition at line 319 of file GA_ATIString.h.

virtual bool GA_ATIString::copy ( const GA_Range destrange,
const GA_Range srcrange 
)
inlinefinalvirtual

Copy attribute values for a range of elements.

Reimplemented from GA_Attribute.

Definition at line 328 of file GA_ATIString.h.

virtual bool GA_ATIString::copy ( const GA_Range destrange,
const GA_Attribute src,
const GA_Range srcrange 
)
inlinefinalvirtual

Copy attribute values for a range of elements.

Reimplemented from GA_Attribute.

Definition at line 332 of file GA_ATIString.h.

bool GA_ATIString::copy ( const GA_Range destrange,
const GA_ATIString src,
const GA_Range srcrange 
)
inline

Copy attribute values for a range of elements.

Definition at line 338 of file GA_ATIString.h.

virtual void GA_ATIString::countMemory ( UT_MemoryCounter counter,
bool  inclusive 
) const
virtual

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.

static GA_Attribute* GA_ATIString::create ( const GA_IndexMap index_map,
GA_AttributeScope  scope,
const UT_StringHolder name,
int  tuple_size,
const GA_AttributeOptions attribute_options = nullptr 
)
static
static GA_Attribute* GA_ATIString::create ( const GA_IndexMap index_map,
const UT_StringHolder name,
int  tuple_size 
)
inlinestatic

Definition at line 82 of file GA_ATIString.h.

virtual bool GA_ATIString::debugValidateArrayCapacity ( GA_Offset  sz) const
virtual

Debug code.

Reimplemented from GA_Attribute.

virtual void GA_ATIString::defragment ( const GA_Defragment defrag)
virtual

Interface for defragmentation.

Implements GA_Attribute.

virtual void GA_ATIString::destructElement ( GA_Offset  offset)
protectedvirtual

Callback method to destruct an offset.

Reimplemented from GA_Attribute.

virtual GA_Attribute* GA_ATIString::doClone ( const GA_IndexMap index_map,
const UT_StringHolder name 
) const
protectedvirtual

Create a new attribute of this type.

Reimplemented from GA_Attribute.

exint GA_ATIString::entries ( ) const
inline

Return the entries in the string container.

Definition at line 111 of file GA_ATIString.h.

exint GA_ATIString::extractStrings ( UT_StringArray strings,
UT_IntArray handles 
) const

Convenience function to extract all the strings (and their handles) The string handles are guaranteed to be in ascending order, but may or may not be contiguous.

exint GA_ATIString::extractStrings ( UT_StringArray strings,
UT_IntArray handles,
exint  maxstrings 
) const

Convenience function to extract all the strings (and their handles) The string handles are guaranteed to be in ascending order, but may or may not be contiguous.

virtual bool GA_ATIString::fill ( const GA_Range destrange,
GA_Offset  srci 
)
inlinefinalvirtual

Assign all elements of a range from a single attribute value.

Reimplemented from GA_Attribute.

Definition at line 346 of file GA_ATIString.h.

virtual bool GA_ATIString::fill ( const GA_Range destrange,
const GA_Attribute src,
GA_Offset  srci 
)
inlinefinalvirtual

Assign all elements of a range from a single attribute value.

Reimplemented from GA_Attribute.

Definition at line 351 of file GA_ATIString.h.

bool GA_ATIString::fill ( const GA_Range destrange,
const GA_ATIString src,
GA_Offset  srci 
)
inline

Assign all elements of a range from a single attribute value.

Definition at line 358 of file GA_ATIString.h.

virtual const GA_AIFCompare* GA_ATIString::getAIFCompare ( ) const
inlinevirtual

Return the attribute's comparison interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 152 of file GA_ATIString.h.

virtual const GA_AIFCopyData* GA_ATIString::getAIFCopyData ( ) const
inlinevirtual

Return the attribute's copy interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 153 of file GA_ATIString.h.

virtual const GA_AIFInterp* GA_ATIString::getAIFInterp ( ) const
inlinevirtual

Return the attribute's interpolation interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 154 of file GA_ATIString.h.

virtual const GA_AIFJSON* GA_ATIString::getAIFJSON ( ) const
inlinevirtual

JSON Schema: GA_ATIString

{
"name" : "GA_ATIString",
"description" : "An tuple array of indexed strings",
"type" : "orderedmap",
"properties": {
"size": {
"type" : "integer",
"minimum" : 1,
"description" : "Tuple size",
"default" : 1,
"optional" : true,
},
"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 195 of file GA_ATIString.h.

virtual const GA_AIFMerge* GA_ATIString::getAIFMerge ( ) const
inlinevirtual

Return the attribute's merge interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 151 of file GA_ATIString.h.

virtual const GA_AIFSharedStringTuple* GA_ATIString::getAIFSharedStringTuple ( ) const
inlinevirtual

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

Reimplemented from GA_Attribute.

Definition at line 159 of file GA_ATIString.h.

virtual const GA_AIFStringTuple* GA_ATIString::getAIFStringTuple ( ) const
inlinevirtual

Return the attribute's string tuple interface or NULL.

Reimplemented from GA_Attribute.

Definition at line 161 of file GA_ATIString.h.

GA_BlobIndex GA_ATIString::getMaximumIndex ( ) const
inline

Return the maximum index of any string in the container. This may be more than the number of strings in the container. If the maximum index is less than 0, there are no strings in the container.

Definition at line 117 of file GA_ATIString.h.

virtual int64 GA_ATIString::getMemoryUsage ( bool  inclusive) const
virtual

Report approximate memory usage.

Implements GA_Attribute.

fpreal GA_ATIString::getStorageOccupancy ( )
inline

Get a measure of the vacancy entropy of the storage container. This.

Definition at line 141 of file GA_ATIString.h.

const UT_StringHolder& GA_ATIString::getString ( GA_Offset  offset,
int  component = 0 
) const
inline

Get a string

Definition at line 203 of file GA_ATIString.h.

SYS_FORCE_INLINE GA_StringIndexType GA_ATIString::getStringIndex ( GA_Offset  offset,
int  component = 0 
) const
inline

Get a string

Definition at line 215 of file GA_ATIString.h.

virtual WriteConcurrence GA_ATIString::getSupportedWriteConcurrence ( ) const
inlinevirtual

Adding strings is thread-safe, so we're only subject to GA_PageArray limitations.

Implements GA_Attribute.

Definition at line 146 of file GA_ATIString.h.

SYS_FORCE_INLINE int GA_ATIString::getTupleSize ( ) const
inline

Get the tuple size.

Definition at line 107 of file GA_ATIString.h.

static SYS_FORCE_INLINE const GA_AttributeType& GA_ATIString::getType ( void  )
inlinestatic

Definition at line 55 of file GA_ATIString.h.

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

Definition at line 52 of file GA_ATIString.h.

virtual void GA_ATIString::hardenAllPages ( GA_Offset  start_offset = GA_Offset(0),
GA_Offset  end_offset = GA_INVALID_OFFSET 
)
virtual

Harden data pages Will harden all pages overlapping the specified offset range. Once this is done, multiple threads can write to an attribute in parallel at a finer granularity than pages. Must be implemented in subclasses

Implements GA_Attribute.

bool GA_ATIString::isEqual ( GA_Offset  offset,
const GA_ATIString b,
GA_Offset  b_offset 
) const

Interface used by GA_AIFCompare.

bool GA_ATIString::isEqual ( const GA_Range range,
const GA_ATIString b,
const GA_Range b_range 
) const

Interface used by GA_AIFCompare.

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

Definition at line 58 of file GA_ATIString.h.

bool GA_ATIString::jsonLoad ( UT_JSONParser p,
const GA_LoadMap load,
const char *  token 
)
bool GA_ATIString::jsonLoadStrings ( UT_JSONParser p,
const GA_LoadMap lmap,
UT_StringArray strings 
)
bool GA_ATIString::jsonSave ( UT_JSONWriter w,
const GA_SaveMap s,
const char *  token 
) const
virtual void GA_ATIString::loadStringsFinishH9 ( const UT_IntArray handlemap)
virtual
virtual bool GA_ATIString::loadStringsH9 ( UT_IStream is,
UT_IntArray handlemap 
)
virtual
GA_StringIndexType GA_ATIString::lookupHandle ( const UT_StringHolder s) const
const char* GA_ATIString::lookupOrderedString ( exint  handle) const
const char* GA_ATIString::lookupString ( GA_StringIndexType  handle) const
virtual bool GA_ATIString::matchesStorage ( const GA_Attribute that) const
inlinevirtual

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 284 of file GA_ATIString.h.

GA_Attribute* GA_ATIString::mergeAddDestination ( const GA_MergeMap map,
GA_Attribute dattrib 
) const

Base class implementation of GA_AIFMerge::addDestination()

bool GA_ATIString::mergeAppendData ( const GA_MergeMap map,
const GA_Attribute sattrib 
)

Base class implementation of GA_AIFMerge::copyArray()

void GA_ATIString::mergeDestroyDestination ( const GA_MergeMap map,
GA_Attribute dattrib 
) const

GA_AIFMerge Base class implementation of GA_AIFMerge::destroyDestination()

void GA_ATIString::mergeGrowArray ( const GA_MergeMap map,
const GA_ATIString s 
)

Base class implementation of GA_AIFMerge::growArray()

virtual bool GA_ATIString::needDestruction ( ) const
protectedvirtual

String attributes need each element to properly destruct for accurate reference counting.

Reimplemented from GA_Attribute.

virtual void GA_ATIString::reconstructElementBlock ( GA_Offset  offset,
GA_Offset  nelements 
)
virtual

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)

Reimplemented from GA_Attribute.

static void GA_ATIString::registerType ( )
static
virtual void GA_ATIString::replace ( const GA_Attribute src)
virtual

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_ATIString::replaceString ( GA_StringIndexType  handle,
const UT_StringHolder new_string 
)
virtual bool GA_ATIString::saveStringsH9 ( std::ostream &  os,
int  binary,
UT_IntArray handlemap 
) const
virtual
virtual bool GA_ATIString::setArraySize ( GA_Offset  size)
virtual

The method to set array size Must be implemented in subclasses Return true if the attribute was resized.

Implements GA_Attribute.

void GA_ATIString::setString ( GA_Offset  offset,
const UT_StringHolder str,
int  component = 0 
)

Set a string

void GA_ATIString::setStringIndex ( GA_Offset  offset,
GA_StringIndexType  i,
int  component = 0 
)

Set a string

void GA_ATIString::setStringIndex ( const GA_Range dst_range,
GA_StringIndexType  i,
int  component = 0 
)

Set a string

bool GA_ATIString::setTupleSize ( int  tuplesize)

Grow or shrink the tuple size.

virtual void GA_ATIString::tryCompressAllPages ( GA_Offset  start_offset = GA_Offset(0),
GA_Offset  end_offset = GA_INVALID_OFFSET 
)
virtual

Try to compress data pages Will try to compress all pages overlapping the specified offset range. Must be implemented in subclasses

Implements GA_Attribute.

bool GA_ATIString::validate ( ) const

Validates the internal structure for debugging purposes.

GA_StringIndexType GA_ATIString::validateHandle ( GA_StringIndexType  h) const

Member Data Documentation

HandleArrayType GA_ATIString::myHandles
protected

Array of handles. The default value is -1.

Definition at line 410 of file GA_ATIString.h.

UT_IndexedHashSet<UT_StringHolder> GA_ATIString::myStrings
protected

String references.

Definition at line 413 of file GA_ATIString.h.


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