DataLengthColumn Class Reference

Class defining the fields necessary to describe a cell (the column value of a specific row) of the data/length column segment. More...

List of all members.

Public Member Functions

 DataLengthColumn (const void *in_dataPtr=NULL, simba_signed_native in_length=CvtLength::MakeNull())
 Constructor.
void GetAttributes (const void *&out_dataPtr, simba_signed_native &out_length) const
 Get all attributes at once.
const void * GetDataPointer () const
 Get the data pointer.
simba_signed_native GetLength () const
 Get the data length.
void SetAttributes (const void *in_dataPtr, simba_signed_native in_length)
 Set all attributes at once.
void SetDataPointer (const void *in_dataPtr)
 Set the data pointer.
void SetLength (simba_signed_native in_length)
 Set the length.

Detailed Description

Class defining the fields necessary to describe a cell (the column value of a specific row) of the data/length column segment.


Constructor & Destructor Documentation

DataLengthColumn ( const void *  in_dataPtr = NULL,
simba_signed_native  in_length = CvtLength::MakeNull() 
) [inline]

Constructor.

Parameters:
in_dataPtr Pointer to the data. (NOT OWN)
in_length Length of the data in bytes, or CvtLength::MakeNull() if NULL.

Member Function Documentation

void GetAttributes ( const void *&  out_dataPtr,
simba_signed_native out_length 
) const [inline]

Get all attributes at once.

Parameters:
out_dataPtr Pointer to the data. (NOT OWN)
out_length Length of the data in bytes, or CvtLength::MakeNull() if NULL.
const void* GetDataPointer (  )  const [inline]

Get the data pointer.

Returns:
Pointer to the data. (NOT OWN)
simba_signed_native GetLength (  )  const [inline]

Get the data length.

Returns:
Length of the data in bytes.
void SetAttributes ( const void *  in_dataPtr,
simba_signed_native  in_length 
) [inline]

Set all attributes at once.

Parameters:
in_dataPtr Pointer to the data. (NOT OWN)
in_length Length of the data in bytes, or CvtLength::MakeNull() if NULL.
void SetDataPointer ( const void *  in_dataPtr  )  [inline]

Set the data pointer.

Parameters:
in_dataPtr Pointer to the data. (NOT OWN)
void SetLength ( simba_signed_native  in_length  )  [inline]

Set the length.

NULL data should be represented by CvtLength::MakeNull().

Parameters:
in_length Length of the data in bytes, or CvtLength::MakeNull() if NULL.

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