sick::datastructure::PacketBuffer Class Reference

A packetbuffer for the raw data from the sensor. More...

#include <PacketBuffer.h>

Public Types
typedef boost::array< uint8_t, MAXSIZE >	ArrayBuffer
	Typedef for an arraybuffer which can be read from the sensor. More...
typedef std::vector< uint8_t >	VectorBuffer
	Typedef for a vector buffer, to sort the incoming packets. More...

Public Member Functions
const VectorBuffer &	getBuffer () const
	Getter to return the VectorBuffer saved in the PacketBuffer. More...
size_t	getLength () const
	Returns length of the current PacketBuffer. More...
	PacketBuffer ()
	Constructor of PacketBuffer. More...
	PacketBuffer (const VectorBuffer &buffer)
	Constructor of PacketBuffer. More...
	PacketBuffer (const ArrayBuffer &buffer, const size_t &length)
	Constructor of PacketBuffer. More...
void	setBuffer (const VectorBuffer &buffer)
	Setter for the PacketBuffer. More...
void	setBuffer (const ArrayBuffer &buffer, const size_t &length)
	Setter for the PacketBuffer. More...

Static Public Member Functions
static uint32_t	getMaxSize ()
	Returns defined maximum size of PacketBuffer. More...

Private Attributes
VectorBuffer	m_buffer

Detailed Description

A packetbuffer for the raw data from the sensor.

Definition at line 61 of file PacketBuffer.h.

Member Typedef Documentation

typedef boost::array<uint8_t, MAXSIZE> sick::datastructure::PacketBuffer::ArrayBuffer

Typedef for an arraybuffer which can be read from the sensor.

Definition at line 67 of file PacketBuffer.h.

typedef std::vector<uint8_t> sick::datastructure::PacketBuffer::VectorBuffer

Typedef for a vector buffer, to sort the incoming packets.

Definition at line 71 of file PacketBuffer.h.

Constructor & Destructor Documentation

sick::datastructure::PacketBuffer::PacketBuffer

(

)

Constructor of PacketBuffer.

Definition at line 41 of file PacketBuffer.cpp.

sick::datastructure::PacketBuffer::PacketBuffer

(

const VectorBuffer &

buffer

)

Constructor of PacketBuffer.

No explicit tag used to allow implicit conversion from different inputs types.

Parameters

buffer

Vectorbuffer to set for the PacketBuffer.

Definition at line 43 of file PacketBuffer.cpp.

sick::datastructure::PacketBuffer::PacketBuffer	(	const ArrayBuffer &	buffer,
		const size_t &	length
	)

Constructor of PacketBuffer.

Parameters

buffer	Arraybuffer to set for the PacketBuffer.
length	Length of the array.

Definition at line 48 of file PacketBuffer.cpp.

Member Function Documentation

const PacketBuffer::VectorBuffer & sick::datastructure::PacketBuffer::getBuffer

(

)

const

Getter to return the VectorBuffer saved in the PacketBuffer.

Returns

VectorBuffer

Definition at line 53 of file PacketBuffer.cpp.

size_t sick::datastructure::PacketBuffer::getLength

(

)

const

Returns length of the current PacketBuffer.

Returns

Length.

Definition at line 70 of file PacketBuffer.cpp.

static uint32_t sick::datastructure::PacketBuffer::getMaxSize ( )

inlinestatic

Returns defined maximum size of PacketBuffer.

Returns

Maximum size of PacketBuffer.

Definition at line 98 of file PacketBuffer.h.

void sick::datastructure::PacketBuffer::setBuffer

(

const VectorBuffer &

buffer

)

Setter for the PacketBuffer.

Parameters

buffer

Input VectorBuffer to save.

Definition at line 58 of file PacketBuffer.cpp.

void sick::datastructure::PacketBuffer::setBuffer	(	const ArrayBuffer &	buffer,
		const size_t &	length
	)

Setter for the PacketBuffer.

Parameters

buffer	Input ArrayBuffer to save.
length	Length of input ArrayBuffer.

Definition at line 64 of file PacketBuffer.cpp.

Member Data Documentation

VectorBuffer sick::datastructure::PacketBuffer::m_buffer

private

Definition at line 127 of file PacketBuffer.h.

---

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

• PacketBuffer.h
• PacketBuffer.cpp