Class RobotState

• Defined in File robot_state.h

Inheritance Relationships

Base Type

• public urcl::primary_interface::PrimaryPackage (Class PrimaryPackage)

Derived Types

• public urcl::primary_interface::ConfigurationData (Class ConfigurationData)

• public urcl::primary_interface::KinematicsInfo (Class KinematicsInfo)

• public urcl::primary_interface::RobotModeData (Class RobotModeData)

Class Documentation

class RobotState : public urcl::primary_interface::PrimaryPackage

Base class for a RobotState data packages will be used directly.

Subclassed by urcl::primary_interface::ConfigurationData, urcl::primary_interface::KinematicsInfo, urcl::primary_interface::RobotModeData

Public Functions

RobotState() = delete

inline RobotState(const RobotStateType type)

Creates a new RobotState object, setting the type of state message.

Parameters:

type – The type of state message

virtual ~RobotState() = 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 specific 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