IndexType Class Reference
#include <adskDataIndexType.h>
Complex index type for referencing metadata.
adsk::Data::Stream objects contain a list of data elements. Each element has to be accessed by Index. This is the base class for the complex index types.
Copy constructor, simplest level.
 Parameters

std::string asString 
( 
 ) 
const 

pure virtual 
Get this index type value as a string.
 Returns
 The index type value in string form (as expected by the string constructor)
Implemented in IndexPair, and IndexString.
bool supportsDenseMode 
( 
 ) 
const 

pure virtual 
Check if this object type supports dense packing indexing.
 Returns
 true if the index type supports dense packing
Implemented in IndexPair, and IndexString.
IndexCount denseSpaceBetween 
( 
const IndexType & 
rhs  ) 
const 

pure virtual 
Calculate the number of elements to be packed between this one and the rhs.
 Parameters

[in]  rhs  Object from which the packing size is calculated 
 Returns
 Number of index values between this one and the rhs
Implemented in IndexPair, and IndexString.
bool operator== 
( 
const IndexType & 
rhs  ) 
const 

pure virtual 
Equality comparison of this object and the rhs.
GTinequality comparison of this object and the rhs.
GEinequality comparison of this object and the rhs.
 Parameters

[in]  rhs  Object being compared against 
 Returns
 true if the two objects are equal
 Parameters

[in]  rhs  Object being compared against 
 Returns
 true if this object is less than the rhs
 Parameters

[in]  rhs  Object being compared against 
 Returns
 true if this object is greater than or equal to the rhs
Implemented in IndexPair, and IndexString.
bool operator!= 
( 
const IndexType & 
rhs  ) 
const 

pure virtual 
Unequality comparison of this object and the rhs.
 Parameters

[in]  rhs  Object being compared against 
 Returns
 true if the two objects are not equal
Implemented in IndexPair, and IndexString.
bool operator< 
( 
const IndexType & 
rhs  ) 
const 

pure virtual 
LTinequality comparison of this object and the rhs.
 Parameters

[in]  rhs  Object being compared against 
 Returns
 true if this object is less than or equal to the rhs
Implemented in IndexPair, and IndexString.
bool operator<= 
( 
const IndexType & 
rhs  ) 
const 

pure virtual 
LEinequality comparison of this object and the rhs.
 Parameters

[in]  rhs  Object being compared against 
 Returns
 true if this object is greater than the rhs
Implemented in IndexPair, and IndexString.
std::string typeName 
( 
 ) 
const 

pure virtual 
The documentation for this class was generated from the following files:
 adskDataIndexType.h
 adskDataIndexType.cpp