sl_oc::tools::SI_ConvertA< SI_CHAR > Class Template Reference

#include <calibration.hpp>

Public Member Functions
	SI_ConvertA (bool a_bStoreIsUtf8)
	SI_ConvertA (const SI_ConvertA &rhs)
SI_ConvertA &	operator= (const SI_ConvertA &rhs)
size_t	SizeFromStore (const char *a_pInputData, size_t a_uInputDataLen)
bool	ConvertFromStore (const char *a_pInputData, size_t a_uInputDataLen, SI_CHAR *a_pOutputData, size_t a_uOutputDataSize)
size_t	SizeToStore (const SI_CHAR *a_pInputData)
bool	ConvertToStore (const SI_CHAR *a_pInputData, char *a_pOutputData, size_t a_uOutputDataSize)

Protected Member Functions
	SI_ConvertA ()

Detailed Description

template<class SI_CHAR>
class sl_oc::tools::SI_ConvertA< SI_CHAR >

Null conversion class for MBCS/UTF-8 to char (or equivalent).

Definition at line 2553 of file calibration.hpp.

Constructor & Destructor Documentation

SI_ConvertA() [1/3]

template<class SI_CHAR >

sl_oc::tools::SI_ConvertA< SI_CHAR >::SI_ConvertA ( )

inlineprotected

Definition at line 2557 of file calibration.hpp.

                  {
    }

SI_ConvertA() [2/3]

template<class SI_CHAR >

sl_oc::tools::SI_ConvertA< SI_CHAR >::SI_ConvertA ( bool  a_bStoreIsUtf8 )

inline

Definition at line 2561 of file calibration.hpp.

                                     : m_bStoreIsUtf8(a_bStoreIsUtf8) {
    }

SI_ConvertA() [3/3]

template<class SI_CHAR >

sl_oc::tools::SI_ConvertA< SI_CHAR >::SI_ConvertA ( const SI_ConvertA< SI_CHAR > &  rhs )

inline

Definition at line 2565 of file calibration.hpp.

                                         {
        operator=(rhs);
    }

References sl_oc::tools::SI_ConvertA< SI_CHAR >::operator=().

Member Function Documentation

ConvertFromStore()

template<class SI_CHAR >

bool sl_oc::tools::SI_ConvertA< SI_CHAR >::ConvertFromStore ( const char *  a_pInputData, size_t  a_uInputDataLen, SI_CHAR *  a_pOutputData, size_t  a_uOutputDataSize  )

inline

Convert the input string from the storage format to SI_CHAR. The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData	Data in storage format to be converted to SI_CHAR.
a_uInputDataLen	Length of storage format data in bytes. This must be the actual length of the data, including NULL byte if NULL terminated string is required.
a_pOutputData	Pointer to the output buffer to received the converted data.
a_uOutputDataSize	Size of the output buffer in SI_CHAR.

Returns

true if all of the input data was successfully converted.

Definition at line 2610 of file calibration.hpp.

                                      {
        // ASCII/MBCS/UTF-8 needs no conversion
        if (a_uInputDataLen > a_uOutputDataSize) {
            return false;
        }
        memcpy(a_pOutputData, a_pInputData, a_uInputDataLen);
        return true;
    }

ConvertToStore()

template<class SI_CHAR >

bool sl_oc::tools::SI_ConvertA< SI_CHAR >::ConvertToStore ( const SI_CHAR *  a_pInputData, char *  a_pOutputData, size_t  a_uOutputDataSize  )

inline

Convert the input string to the storage format of this data. The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData	NULL terminated source string to convert. All of the data will be converted including the terminating NULL character.
a_pOutputData	Pointer to the buffer to receive the converted string.
a_uOutputDataSize	Size of the output buffer in char.

Returns

true if all of the input data, including the terminating NULL character was successfully converted.

Definition at line 2652 of file calibration.hpp.

                                      {
        // calc input string length (SI_CHAR type and size independent)
        size_t uInputLen = strlen((const char *) a_pInputData) + 1;
        if (uInputLen > a_uOutputDataSize) {
            return false;
        }
 
        // ascii/UTF-8 needs no conversion
        memcpy(a_pOutputData, a_pInputData, uInputLen);
        return true;
    }

operator=()

template<class SI_CHAR >

SI_ConvertA& sl_oc::tools::SI_ConvertA< SI_CHAR >::operator= ( const SI_ConvertA< SI_CHAR > &  rhs )

inline

Definition at line 2569 of file calibration.hpp.

                                                     {
        m_bStoreIsUtf8 = rhs.m_bStoreIsUtf8;
        return *this;
    }

Referenced by sl_oc::tools::SI_ConvertA< SI_CHAR >::SI_ConvertA().

SizeFromStore()

template<class SI_CHAR >

size_t sl_oc::tools::SI_ConvertA< SI_CHAR >::SizeFromStore ( const char *  a_pInputData, size_t  a_uInputDataLen  )

inline

Calculate the number of SI_CHAR required for converting the input from the storage format. The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData	Data in storage format to be converted to SI_CHAR.
a_uInputDataLen	Length of storage format data in bytes. This must be the actual length of the data, including NULL byte if NULL terminated string is required.

Returns

Number of SI_CHAR required by the string when converted. If there are embedded NULL bytes in the input data, only the string up and not including the NULL byte will be converted.

-1 cast to size_t on a conversion error.

Definition at line 2587 of file calibration.hpp.

                                    {
        (void) a_pInputData;
        SI_ASSERT(a_uInputDataLen != (size_t) - 1);
 
        // ASCII/MBCS/UTF-8 needs no conversion
        return a_uInputDataLen;
    }

SizeToStore()

template<class SI_CHAR >

size_t sl_oc::tools::SI_ConvertA< SI_CHAR >::SizeToStore ( const SI_CHAR *  a_pInputData )

inline

Calculate the number of char required by the storage format of this data. The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData

NULL terminated string to calculate the number of bytes required to be converted to storage format.

Returns

Number of bytes required by the string when converted to storage format. This size always includes space for the terminating NULL character.

-1 cast to size_t on a conversion error.

Definition at line 2633 of file calibration.hpp.

                                          {
        // ASCII/MBCS/UTF-8 needs no conversion
        return strlen((const char *) a_pInputData) + 1;
    }

---

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

• calibration.hpp