OpenJAUS SAE SDK  6.0.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
openjaus::system::Buffer::ReaderImpl Class Reference

Inherits openjaus::system::BufferReader.

Public Member Functions

 ReaderImpl (RandomAccessBuffer &buffer)
 
virtual ~ReaderImpl ()
 
virtual uint64 bytesRemaining () const
 
virtual uint64 bytesContained () const
 
template<typename Type >
int peekTemplate (Type &value) const
 
virtual uint64 peek (int8 &value) const
 
virtual uint64 peek (int16 &value) const
 
virtual uint64 peek (int32 &value) const
 
virtual uint64 peek (int64 &value) const
 
virtual uint64 peek (uint8 &value) const
 
virtual uint64 peek (uint16 &value) const
 
virtual uint64 peek (uint32 &value) const
 
virtual uint64 peek (uint64 &value) const
 
virtual uint64 peek (float &value) const
 
virtual uint64 peek (double &value) const
 
virtual uint64 peek (std::string &dst) const
 
virtual uint64 peek (std::string &dst, uint64 length) const
 
virtual uint64 peek (unsigned char *const buffer, uint64 length) const
 
virtual uint64 peek (MemoryBlock &buffer, uint64 length) const
 
virtual uint64 peek (RandomAccessBuffer &value, uint64 startPos, uint64 length) const
 Copy data out of the Buffer associated with this BufferReader and put in the provided RandomAccessBuffer Copy data out of the Buffer associated with this BufferReader and put in the provided RandomAccessBuffer but don't update the read position of the BufferReader. More...
 
virtual uint64 peek (Transportable &value) const
 
template<typename Type >
int unpackTemplate (Type &value)
 
virtual uint64 unpack (int8 &value)
 
virtual uint64 unpack (int16 &value)
 
virtual uint64 unpack (int32 &value)
 
virtual uint64 unpack (int64 &value)
 
virtual uint64 unpack (uint8 &value)
 
virtual uint64 unpack (uint16 &value)
 
virtual uint64 unpack (uint32 &value)
 
virtual uint64 unpack (uint64 &value)
 
virtual uint64 unpack (float &value)
 
virtual uint64 unpack (double &value)
 
virtual uint64 unpack (std::string &dst)
 
virtual uint64 unpack (std::string &dst, uint64 length)
 
virtual uint64 unpack (unsigned char *const buffer, uint64 length)
 
virtual uint64 unpack (MemoryBlock &buffer, uint64 length)
 
virtual uint64 unpack (RandomAccessBuffer &value, uint64 startPos, uint64 length)
 Copy data out of the Buffer associated with this BufferReader and put in the provided RandomAccessBuffer Copy data out of the Buffer associated with this BufferReader and put in the provided RandomAccessBuffer, and update the read position of the BufferReader. More...
 
virtual uint64 unpack (Transportable &value)
 
virtual void increment (uint64 length)
 
virtual void reset ()
 
- Public Member Functions inherited from openjaus::system::BufferReader
virtual ~BufferReader ()
 

Private Member Functions

void throwExceptionIfBufferTooSmall (uint64 length) const
 

Private Attributes

RandomAccessBufferbuffer
 
uint64 readPos
 

Additional Inherited Members

- Protected Member Functions inherited from openjaus::system::BufferReader
 BufferReader ()
 

Constructor & Destructor Documentation

◆ ReaderImpl()

openjaus::system::Buffer::ReaderImpl::ReaderImpl ( RandomAccessBuffer buffer)

◆ ~ReaderImpl()

openjaus::system::Buffer::ReaderImpl::~ReaderImpl ( )
virtual

Member Function Documentation

◆ bytesContained()

uint64 openjaus::system::Buffer::ReaderImpl::bytesContained ( ) const
virtual

◆ bytesRemaining()

uint64 openjaus::system::Buffer::ReaderImpl::bytesRemaining ( ) const
virtual

◆ increment()

void openjaus::system::Buffer::ReaderImpl::increment ( uint64  length)
virtual

◆ peek() [1/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( int8 value) const
virtual

◆ peek() [2/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( int16 value) const
virtual

◆ peek() [3/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( int32 value) const
virtual

◆ peek() [4/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( int64 value) const
virtual

◆ peek() [5/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( uint8 value) const
virtual

◆ peek() [6/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( uint16 value) const
virtual

◆ peek() [7/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( uint32 value) const
virtual

◆ peek() [8/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( uint64 value) const
virtual

◆ peek() [9/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( float &  value) const
virtual

◆ peek() [10/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( double &  value) const
virtual

◆ peek() [11/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( std::string &  dst) const
virtual

◆ peek() [12/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( std::string &  dst,
uint64  length 
) const
virtual

◆ peek() [13/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( unsigned char *const  buffer,
uint64  length 
) const
virtual

◆ peek() [14/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( MemoryBlock buffer,
uint64  length 
) const
virtual

◆ peek() [15/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( RandomAccessBuffer value,
uint64  startPos,
uint64  length 
) const
virtual
Parameters
[in]valueThe RandomAccessBuffer to copy the data from
[in]startPosThe position in the RandomAccessBuffer to start copying the data
[in]lengthThe length of the data to be copied

Implements openjaus::system::BufferReader.

◆ peek() [16/16]

uint64 openjaus::system::Buffer::ReaderImpl::peek ( Transportable value) const
virtual

◆ peekTemplate()

template<typename Type >
int openjaus::system::Buffer::ReaderImpl::peekTemplate ( Type &  value) const

◆ reset()

void openjaus::system::Buffer::ReaderImpl::reset ( )
virtual

◆ throwExceptionIfBufferTooSmall()

void openjaus::system::Buffer::ReaderImpl::throwExceptionIfBufferTooSmall ( uint64  length) const
private

◆ unpack() [1/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( int8 value)
virtual

◆ unpack() [2/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( int16 value)
virtual

◆ unpack() [3/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( int32 value)
virtual

◆ unpack() [4/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( int64 value)
virtual

◆ unpack() [5/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( uint8 value)
virtual

◆ unpack() [6/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( uint16 value)
virtual

◆ unpack() [7/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( uint32 value)
virtual

◆ unpack() [8/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( uint64 value)
virtual

◆ unpack() [9/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( float &  value)
virtual

◆ unpack() [10/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( double &  value)
virtual

◆ unpack() [11/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( std::string &  dst)
virtual

◆ unpack() [12/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( std::string &  dst,
uint64  length 
)
virtual

◆ unpack() [13/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( unsigned char *const  buffer,
uint64  length 
)
virtual

◆ unpack() [14/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( MemoryBlock buffer,
uint64  length 
)
virtual

◆ unpack() [15/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( RandomAccessBuffer value,
uint64  startPos,
uint64  length 
)
virtual
Parameters
[in]valueThe RandomAccessBuffer to copy the data from
[in]startPosThe position in the RandomAccessBuffer to start copying the data
[in]lengthThe length of the data to be copied

Implements openjaus::system::BufferReader.

◆ unpack() [16/16]

uint64 openjaus::system::Buffer::ReaderImpl::unpack ( Transportable value)
virtual

◆ unpackTemplate()

template<typename Type >
int openjaus::system::Buffer::ReaderImpl::unpackTemplate ( Type &  value)

Member Data Documentation

◆ buffer

RandomAccessBuffer& openjaus::system::Buffer::ReaderImpl::buffer
private

◆ readPos

uint64 openjaus::system::Buffer::ReaderImpl::readPos
private

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