Class TextMessage

Inheritance Relationships

Base Type

Class Documentation

class TextMessage : public urcl::primary_interface::RobotMessage

The TextMessage class handles the text messages sent via the primary UR interface.

Public Functions

TextMessage() = delete
inline TextMessage(uint64_t timestamp, int8_t source)

Creates a new TextMessage object to be filled from a package.

Parameters:
  • timestamp – Timestamp of the package

  • source – The package’s source

inline TextMessage(const TextMessage &pkg)

Creates a copy of a TextMessage object.

Parameters:

pkg – The TextMessage object to be copied

virtual ~TextMessage() = default
virtual bool parseWith(comm::BinParser &bp)

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

Parameters:

bp – A parser containing a serialized text of the package

Returns:

True, if the package was parsed successfully, false otherwise

virtual bool consumeWith(AbstractPrimaryConsumer &consumer)

Consume this package with a specific consumer.

Parameters:

consumer – Placeholder for the consumer calling this

Returns:

true on success

virtual std::string toString() const

Produces a human readable representation of the package object.

Returns:

A string representing the object

Public Members

std::string text_