CvtLength Class Reference

The CvtLength class provides static functions that handles the coding of the length parameters used by the conversion functors (all classes specializing the SqlToCFunctor template). More...

List of all members.

Static Public Member Functions

static simba_signed_native GetLength (simba_signed_native in_codedLength)
 Get the data length from a coded length. If the coded length corresponds to a NULL data or retrieval error, 0 is returned.
static bool IsAtExec (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that is provided at execution.
static bool IsDefault (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that is the default value.
static bool IsIgnore (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that has to be ignored.
static bool IsLength (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that was not truncated and is not NULL.
static bool IsNull (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that is NULL.
static bool IsRetrievalError (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that was not retrieved successfully.
static bool IsTruncated (simba_signed_native in_codedLength)
 Check if a coded length corresponds to a data that was not truncated.
static simba_signed_native MakeAtExec ()
 Get the coded length for the length of a data that is provided at execution.
static simba_signed_native MakeDefault ()
 Get the coded length for the length of a data that takes the default value.
static simba_signed_native MakeIgnore ()
 Get the coded length for the length of a data that has to be ignored.
static simba_signed_native MakeLength (simba_signed_native in_dataLength)
 Get the coded length for the length of a data that was not truncated and is not NULL.
static simba_signed_native MakeNull ()
 Get the coded length for the length of a data that is NULL.
static simba_signed_native MakeRetrievalError ()
 Get the coded length for the length of a data that was not retrieved successfully.
static simba_signed_native MakeTruncated (simba_signed_native in_dataLength)
 Get the coded length for the length of a data that was truncated.

Detailed Description

The CvtLength class provides static functions that handles the coding of the length parameters used by the conversion functors (all classes specializing the SqlToCFunctor template).


Member Function Documentation

static simba_signed_native GetLength ( simba_signed_native  in_codedLength  )  [inline, static]

Get the data length from a coded length. If the coded length corresponds to a NULL data or retrieval error, 0 is returned.

Parameters:
in_codedLength Coded length.
Returns:
The length of data (possible truncation indication is removed).
static bool IsAtExec ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that is provided at execution.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for data to be ignored, else false.
static bool IsDefault ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that is the default value.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for data to be ignored, else false.
static bool IsIgnore ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that has to be ignored.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for data to be ignored, else false.
static bool IsLength ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that was not truncated and is not NULL.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for a non truncated and non NULL data, else false.
static bool IsNull ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that is NULL.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for NULL data, else false.
static bool IsRetrievalError ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that was not retrieved successfully.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for a retrieval error, else false.
static bool IsTruncated ( simba_signed_native  in_codedLength  )  [inline, static]

Check if a coded length corresponds to a data that was not truncated.

Parameters:
in_codedLength Coded length.
Returns:
True if it a coded length for a truncated data, else false.
static simba_signed_native MakeAtExec (  )  [inline, static]

Get the coded length for the length of a data that is provided at execution.

This value is used when converting parameters in bulk mode for bulk writeback.

Returns:
Coded length.
static simba_signed_native MakeDefault (  )  [inline, static]

Get the coded length for the length of a data that takes the default value.

This value is used when converting parameters in bulk mode for bulk writeback.

Returns:
Coded length.
static simba_signed_native MakeIgnore (  )  [inline, static]

Get the coded length for the length of a data that has to be ignored.

This value is used when converting parameters in bulk mode for bulk writeback.

Returns:
Coded length.
static simba_signed_native MakeLength ( simba_signed_native  in_dataLength  )  [inline, static]

Get the coded length for the length of a data that was not truncated and is not NULL.

Parameters:
in_dataLength Length of the data.
Returns:
Coded length.
static simba_signed_native MakeNull (  )  [inline, static]

Get the coded length for the length of a data that is NULL.

Returns:
Coded length.
static simba_signed_native MakeRetrievalError (  )  [inline, static]

Get the coded length for the length of a data that was not retrieved successfully.

Returns:
Coded length.
static simba_signed_native MakeTruncated ( simba_signed_native  in_dataLength  )  [inline, static]

Get the coded length for the length of a data that was truncated.

Parameters:
in_dataLength Length of the data.
Returns:
Coded length.

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