DSIExtIndexKey Class Reference

A class that represents a key for an index. More...

List of all members.

Public Member Functions

 DSIExtIndexKey (SegmentList in_segmentValues)
 Constructor.
const SegmentGetSegment (simba_uint16 in_segment) const
 Get the value of the specified segment.
simba_uint16 GetSegmentCount () const
 Get the number of segments within the index key.

Detailed Description

A class that represents a key for an index.

This class is used to seek into an index within a table, identifying a row or rows.


Constructor & Destructor Documentation

DSIExtIndexKey ( SegmentList  in_segmentValues  ) 

Constructor.

Parameters:
in_segmentValues The values for the segments of the index. (OWN)

Member Function Documentation

const Segment& GetSegment ( simba_uint16  in_segment  )  const

Get the value of the specified segment.

The pointer returned should be cast to the correct type for the specified segment of the index.

Parameters:
in_segment The 0-based segment index.
Returns:
The associated value for the specified index segment.
simba_uint16 GetSegmentCount (  )  const

Get the number of segments within the index key.

Returning a number greater than 1 indicates the key is a composite key across multiple columns in the table.

Returns:
The number of segments within the index key.

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

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba