 |
sbgECom Library
5.2.590-stable
Interface SBG Systems IMU/AHRS/INS
|
|
sbgECom Library
5.2.590-stable
Interface SBG Systems IMU/AHRS/INS
|
Specific method of stream buffer for little endian readings/writings. More...
#include "sbgStreamBufferCommon.h"Go to the source code of this file.
Specific method of stream buffer for little endian readings/writings.
The MIT license
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
| SBG_INLINE int16_t sbgStreamBufferReadInt16LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int16_t from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE uint16_t sbgStreamBufferReadUint16LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint16_t from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE int32_t sbgStreamBufferReadInt24LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int24 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE uint32_t sbgStreamBufferReadUint24LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint24 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE int32_t sbgStreamBufferReadInt32LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int32_t from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE uint32_t sbgStreamBufferReadUint32LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint32_t from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
Referenced by sbgStreamBufferReadFloatLE(), sbgStreamBufferReadInt64LE(), sbgStreamBufferReadSizeT32LE(), and sbgStreamBufferReadUint64LE().
| SBG_INLINE int64_t sbgStreamBufferReadInt40LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int40 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE int64_t sbgStreamBufferReadUint40LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint40 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE int64_t sbgStreamBufferReadInt48LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int48 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE uint64_t sbgStreamBufferReadUint48LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint48 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE int64_t sbgStreamBufferReadInt56LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int56 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE uint64_t sbgStreamBufferReadUint56LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint56 from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE int64_t sbgStreamBufferReadInt64LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an int64_t from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, sbgStreamBufferGetSpace(), and sbgStreamBufferReadUint32LE().
| SBG_INLINE uint64_t sbgStreamBufferReadUint64LE | ( | SbgStreamBuffer * | pHandle | ) |
Read an uint64_t from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, sbgStreamBufferGetSpace(), and sbgStreamBufferReadUint32LE().
Referenced by sbgStreamBufferReadDoubleLE(), and sbgStreamBufferReadSizeT64LE().
| SBG_INLINE size_t sbgStreamBufferReadSizeT32LE | ( | SbgStreamBuffer * | pHandle | ) |
Read a size_t from a stream buffer that has been stored in a uint32_t (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References SBG_INLINE, and sbgStreamBufferReadUint32LE().
Referenced by sbgStreamBufferReadStringLE().
| SBG_INLINE size_t sbgStreamBufferReadSizeT64LE | ( | SbgStreamBuffer * | pHandle | ) |
Read a size_t from a stream buffer that has been stored in a uint64_t (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References SBG_INLINE, and sbgStreamBufferReadUint64LE().
| SBG_INLINE float sbgStreamBufferReadFloatLE | ( | SbgStreamBuffer * | pHandle | ) |
Read an float from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, sbgStreamBufferGetSpace(), and sbgStreamBufferReadUint32LE().
| SBG_INLINE double sbgStreamBufferReadDoubleLE | ( | SbgStreamBuffer * | pHandle | ) |
Read an double from a stream buffer (Little endian version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
References _SbgStreamBuffer::errorCode, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, sbgStreamBufferGetSpace(), and sbgStreamBufferReadUint64LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt16LE | ( | SbgStreamBuffer * | pHandle, |
| int16_t | value ) |
Write an int16_t into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint16LE | ( | SbgStreamBuffer * | pHandle, |
| uint16_t | value ) |
Write an uint16_t into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt24LE | ( | SbgStreamBuffer * | pHandle, |
| int32_t | value ) |
Write an int24 into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_INVALID_PARAMETER, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint24LE | ( | SbgStreamBuffer * | pHandle, |
| uint32_t | value ) |
Write an uint24 into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_INVALID_PARAMETER, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt32LE | ( | SbgStreamBuffer * | pHandle, |
| int32_t | value ) |
Write an int32_t into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint32LE | ( | SbgStreamBuffer * | pHandle, |
| uint32_t | value ) |
Write an uint32_t into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
Referenced by sbgStreamBufferWriteFloatLE(), and sbgStreamBufferWriteSizeT32LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint48LE | ( | SbgStreamBuffer * | pHandle, |
| uint64_t | value ) |
Write an uint48 into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteInt64LE | ( | SbgStreamBuffer * | pHandle, |
| int64_t | value ) |
Write an int64_t into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteUint64LE | ( | SbgStreamBuffer * | pHandle, |
| uint64_t | value ) |
Write an uint64_t into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, _SbgStreamBuffer::pCurrentPtr, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferGetSpace().
Referenced by sbgStreamBufferWriteDoubleLE(), and sbgStreamBufferWriteSizeT64LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteSizeT32LE | ( | SbgStreamBuffer * | pHandle, |
| size_t | value ) |
Write an size_t into a stream buffer as a uint32_t (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References SBG_INLINE, and sbgStreamBufferWriteUint32LE().
Referenced by sbgStreamBufferWriteStringLE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteSizeT64LE | ( | SbgStreamBuffer * | pHandle, |
| size_t | value ) |
Write an size_t into a stream buffer as a uint64_t (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References SBG_INLINE, and sbgStreamBufferWriteUint64LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteFloatLE | ( | SbgStreamBuffer * | pHandle, |
| float | value ) |
Write an float into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferWriteUint32LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteDoubleLE | ( | SbgStreamBuffer * | pHandle, |
| double | value ) |
Write an double into a stream buffer. (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | value | The value to write. |
References _SbgStreamBuffer::errorCode, SBG_INLINE, SBG_NO_ERROR, and sbgStreamBufferWriteUint64LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferReadStringLE | ( | SbgStreamBuffer * | pHandle, |
| char * | pString, | ||
| size_t | maxSize ) |
Read a C String from a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports read operations. |
| [out] | pString | Buffer that can hold the read NULL terminated C string. |
| [in] | maxSize | Maximum number of bytes that can be stored in pString (including the NULL char). |
References _SbgStreamBuffer::errorCode, SBG_BUFFER_OVERFLOW, SBG_INLINE, SBG_NO_ERROR, sbgStreamBufferReadBuffer(), and sbgStreamBufferReadSizeT32LE().
| SBG_INLINE SbgErrorCode sbgStreamBufferWriteStringLE | ( | SbgStreamBuffer * | pHandle, |
| const char * | pString ) |
Write a NULL terminated C String into a stream buffer (Little Endian Version).
| [in] | pHandle | Valid stream buffer handle that supports write operations. |
| [in] | pString | NULL terminated C String to write to the stream buffer. |
References _SbgStreamBuffer::errorCode, SBG_INLINE, SBG_INVALID_PARAMETER, SBG_NO_ERROR, sbgStreamBufferWriteBuffer(), and sbgStreamBufferWriteSizeT32LE().
1.13.2