This class handles RTDE text messages sent by the robot. More...

#include <text_message.h>

Inheritance diagram for urcl::rtde_interface::TextMessage:

Public Member Functions
virtual bool	parseWith (comm::BinParser &bp)
	Sets the attributes of the package by parsing a serialized representation of the package. More...

	TextMessage (uint16_t protocol_version)
	Creates a new TextMessage object. More...

virtual std::string	toString () const
	Produces a human readable representation of the package object. More...

virtual	~TextMessage ()=default

Public Member Functions inherited from urcl::rtde_interface::RTDEPackage
	RTDEPackage ()=delete
	Creates a new RTDEPackage object. More...

	RTDEPackage (const PackageType type)

virtual	~RTDEPackage ()=default

Public Member Functions inherited from urcl::comm::URPackage< PackageHeader >
	URPackage ()=default
	Creates a new URPackage object. More...

virtual	~URPackage ()=default

Public Attributes
std::string	message_

uint8_t	message_length_

uint8_t	message_type_

uint16_t	protocol_version_

std::string	source_

uint8_t	source_length_

uint8_t	warning_level_

Additional Inherited Members
Public Types inherited from urcl::comm::URPackage< PackageHeader >
using	HeaderType = PackageHeader

Protected Attributes inherited from urcl::rtde_interface::RTDEPackage
std::unique_ptr< uint8_t >	buffer_

size_t	buffer_length_

PackageType	type_

Detailed Description

This class handles RTDE text messages sent by the robot.

Definition at line 41 of file text_message.h.

Constructor & Destructor Documentation

◆ TextMessage()

urcl::rtde_interface::TextMessage::TextMessage ( uint16_t protocol_version )

inline

Creates a new TextMessage object.

Parameters

protocol_version Protocol version used for the RTDE communication

Definition at line 49 of file text_message.h.

◆ ~TextMessage()

virtual urcl::rtde_interface::TextMessage::~TextMessage ( )

virtualdefault

Member Function Documentation

◆ parseWith()

bool urcl::rtde_interface::TextMessage::parseWith ( comm::BinParser & bp )

virtual

Sets the attributes of the package by parsing a serialized representation of the package.

Parameters

bp	A parser containing a serialized version of the package

Returns: True, if the package was parsed successfully, false otherwise

Reimplemented from urcl::rtde_interface::RTDEPackage.

Definition at line 35 of file text_message.cpp.

◆ toString()

std::string urcl::rtde_interface::TextMessage::toString ( ) const

virtual

Produces a human readable representation of the package object.

Returns: A string representing the object

Reimplemented from urcl::rtde_interface::RTDEPackage.

Definition at line 53 of file text_message.cpp.

Member Data Documentation

◆ message_

std::string urcl::rtde_interface::TextMessage::message_

Definition at line 72 of file text_message.h.

◆ message_length_

uint8_t urcl::rtde_interface::TextMessage::message_length_

Definition at line 71 of file text_message.h.

◆ message_type_

uint8_t urcl::rtde_interface::TextMessage::message_type_

Definition at line 77 of file text_message.h.

◆ protocol_version_

uint16_t urcl::rtde_interface::TextMessage::protocol_version_

Definition at line 79 of file text_message.h.

◆ source_

std::string urcl::rtde_interface::TextMessage::source_

Definition at line 74 of file text_message.h.

◆ source_length_

uint8_t urcl::rtde_interface::TextMessage::source_length_

Definition at line 73 of file text_message.h.

◆ warning_level_

uint8_t urcl::rtde_interface::TextMessage::warning_level_

Definition at line 75 of file text_message.h.

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

Public Member Functions

Public Attributes

Additional Inherited Members