Class KeyMessage
Defined in File key_message.h
Inheritance Relationships
Base Type
public urcl::primary_interface::RobotMessage(Class RobotMessage)
Class Documentation
-
class KeyMessage : public urcl::primary_interface::RobotMessage
Representation of the primary interface’s KeyMessage.
Public Functions
-
KeyMessage() = delete
-
inline KeyMessage(uint64_t timestamp, int8_t source)
Creates a new KeyMessage object to be filled from a package.
- Parameters:
timestamp – Timestamp of the package
source – The package’s source
-
KeyMessage(const KeyMessage &pkg)
-
virtual ~KeyMessage() = 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
-
KeyMessage() = delete