ObjectDatabase++ Documentation - Class CODBPP::Index

Delevopers ObjectDatabase++ API Class CODBPP::Index

Class CODBPP::Index

class Index{
public:
   unsigned char flags;
   unsigned char type;
   unsigned short segmentCount;
   union{
      unsigned int length;
      struct{
         unsigned short binaryLength;
         unsigned short maxObjects;
      };
   };
   CODBPP::Segment *segments;
};

Members

flags	Boolean values for fixed or variable and multi-entry type index, 0x01 = variable, 0x02 = multientry.
type	CODBPP::IndexType value for the index.
segmentCount	A counter for the number of segments in this index.
length	If the index type equals CODBPP::B_TREE or CODBPP::S_TREE than the length for the fixed index or the average length for the variable index - (length * 4) = length in bytes.
binaryLength	If the index type equals CODBPP::A_LIST or CODBPP::U_LIST, the length in bytes of the pre-token binary section.
maxObjects	If the index type equals CODBPP::A_LIST or CODBPP::U_LIST, then pow(2,maxObjects) equals maximum object count before disregarding token value, typically token as "the" and "a" are removed from the index as they may provide too many hits. If this value is 0 then there is not maximum count.
segments	Pointer to an array of segments