Pipe Inpection Robot / Mbed OS capstone_finish

Dependencies:   BufferedSerial motor_sn7544

Embed: (wiki syntax)

« Back to documentation index

Stream Struct Reference

Stream Struct Reference

Stream base-class, provides common functionality for IStream and OStream. More...

#include <serialization.h>

Inherited by IStream, and OStream.

Public Member Functions

ROS_FORCE_INLINE uint8_t * advance (uint32_t len)
 Advances the stream, checking bounds, and returns a pointer to the position before it was advanced.
uint32_t getLength ()
 Returns the amount of space left in the stream.

Detailed Description

Stream base-class, provides common functionality for IStream and OStream.

Definition at line 662 of file serialization.h.


Member Function Documentation

ROS_FORCE_INLINE uint8_t* advance ( uint32_t  len )

Advances the stream, checking bounds, and returns a pointer to the position before it was advanced.

Exceptions:
StreamOverrunExceptionif len would take this stream past the end of its buffer

Definition at line 673 of file serialization.h.

uint32_t getLength (  )

Returns the amount of space left in the stream.

Definition at line 689 of file serialization.h.