Class RobotMessage
Defined in File robot_message.h
Inheritance Relationships
Base Type
public urcl::primary_interface::PrimaryPackage(Class PrimaryPackage)
Derived Types
public urcl::primary_interface::ErrorCodeMessage(Class ErrorCodeMessage)public urcl::primary_interface::VersionMessage(Class VersionMessage)
Class Documentation
-
class RobotMessage : public urcl::primary_interface::PrimaryPackage
The RobotMessage class is a parent class for the different received robot messages.
Subclassed by urcl::primary_interface::ErrorCodeMessage, urcl::primary_interface::VersionMessage
Public Functions
-
inline RobotMessage(const uint64_t timestamp, const uint8_t source)
Creates a new RobotMessage object to be filled from a package.
- Parameters:
timestamp – Timestamp of the package
source – The package’s source
-
inline RobotMessage(const uint64_t timestamp, const int8_t source, const RobotMessagePackageType message_type)
Creates a new RobotMessage object to be filled from a package.
- Parameters:
timestamp – Timestamp of the package
source – The package’s source
message_type – The package’s message type
-
virtual ~RobotMessage() = 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 version 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
-
inline RobotMessage(const uint64_t timestamp, const uint8_t source)