AbstractColumnSegment Class Reference

Based column segment abstract class. More...

Inherited by ServerColumnSegment, DataLengthColumnSegment, and FixedRowSizeColumnSegment.

List of all members.

Public Member Functions

 AbstractColumnSegment (simba_uint32 in_strategyId, simba_unsigned_native in_numberRows=0)
 Constructor. Set the column segment strategy identifier.
simba_unsigned_native GetNumberRows () const
 Get the number of rows covered by this segment (see m_numberRows attribute comment).
simba_uint32 GetStrategyId () const
 Get the strategy identifier associated with this segment.

Static Public Attributes

static const simba_uint32 DATALENGTH_ID = (FIXEDROWSIZE_ID + 1)
 Column segment identifier value for the DataLengthColumnSegment class.
static const simba_uint32 FIXEDROWSIZE_ID = 1
 Column segment identifier value for the FixedRowSizeColumnSegment class.
static const simba_uint32 SERVER_ID = (DATALENGTH_ID + 1)
 Column segment identifier value for the ServerColumnSegment class.
static const simba_uint32 STARTCUSTOM_ID = 0x8000
 First column segment identifier value that can be used for custom column segment strategy.

Protected Member Functions

void SetNumberRows (simba_unsigned_native in_numberRows)
 Set the number of rows covered by this segment (see m_numberRows attribute comment).

Detailed Description

Based column segment abstract class.

Column segments allows a DSII to describe where multiple row values for a specific column have been retrieved and stored in memory. They are then used by bulk converters to convert all retrieved value and store the latter in their corresponding target buffers.

The SEN SDK provides implementations for a few generic column segments as well as the corresponding bulk converters functions. A DSII can implement its own column segment, but then has to extend the bulk converter template in order to support the new column segments.

The existing implementations are:

Column segment have an identifier, called strategy identifier, that allows the bulk converters to know how to interpret the segment object. This means that the bulk converter needs to implement support for each strategy that it should support.


Constructor & Destructor Documentation

AbstractColumnSegment ( simba_uint32  in_strategyId,
simba_unsigned_native  in_numberRows = 0 
) [inline]

Constructor. Set the column segment strategy identifier.

Parameters:
in_strategyId Column segment strategy identifier.
in_numberRows Number of rows this segment covers. 0 by default. Can be updated later on by any inheriting class with SetNumberRows().

Member Function Documentation

simba_unsigned_native GetNumberRows (  )  const [inline]

Get the number of rows covered by this segment (see m_numberRows attribute comment).

Returns:
Number of rows covered by this segment.
simba_uint32 GetStrategyId (  )  const [inline]

Get the strategy identifier associated with this segment.

Returns:
Strategy identifier associated at construction.
void SetNumberRows ( simba_unsigned_native  in_numberRows  )  [inline, protected]

Set the number of rows covered by this segment (see m_numberRows attribute comment).

Returns:
Number of rows covered by this segment.

Member Data Documentation

const simba_uint32 DATALENGTH_ID = (FIXEDROWSIZE_ID + 1) [static]

Column segment identifier value for the DataLengthColumnSegment class.

const simba_uint32 FIXEDROWSIZE_ID = 1 [static]

Column segment identifier value for the FixedRowSizeColumnSegment class.

const simba_uint32 SERVER_ID = (DATALENGTH_ID + 1) [static]

Column segment identifier value for the ServerColumnSegment class.

const simba_uint32 STARTCUSTOM_ID = 0x8000 [static]

First column segment identifier value that can be used for custom column segment strategy.


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

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