urcl::rtde_interface::PackageHeader Class Reference

This class represents the header for RTDE packages. More...

#include <package_header.h>

Public Types
using	_package_size_type = uint16_t

Public Member Functions
	PackageHeader ()=default
virtual	~PackageHeader ()=default

Static Public Member Functions
static size_t	getPackageLength (uint8_t *buf)
	Reads a buffer, interpreting the next bytes as the size of the contained package. More...
static size_t	serializeHeader (uint8_t *buffer, PackageType package_type, uint16_t payload_length)
	Creates a serialization of a header based on given values. More...

Detailed Description

This class represents the header for RTDE packages.

Definition at line 59 of file rtde/package_header.h.

Member Typedef Documentation

using urcl::rtde_interface::PackageHeader::_package_size_type = uint16_t

Definition at line 64 of file rtde/package_header.h.

Constructor & Destructor Documentation

urcl::rtde_interface::PackageHeader::PackageHeader ( )

default

virtual urcl::rtde_interface::PackageHeader::~PackageHeader ( )

virtualdefault

Member Function Documentation

static size_t urcl::rtde_interface::PackageHeader::getPackageLength ( uint8_t *  buf )

inlinestatic

Reads a buffer, interpreting the next bytes as the size of the contained package.

Parameters

buf	The given byte stream containing a serialized package

Returns

The size of the given serialized package

Definition at line 73 of file rtde/package_header.h.

static size_t urcl::rtde_interface::PackageHeader::serializeHeader ( uint8_t *  buffer, PackageType  package_type, uint16_t  payload_length  )

inlinestatic

Creates a serialization of a header based on given values.

Parameters

buffer	The buffer to write the serialization to
package_type	The type of the package
payload_length	The length of the package's payload

Returns

Definition at line 87 of file rtde/package_header.h.

---

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

• rtde/package_header.h