urcl::primary_interface::RobotState Class Reference

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

#include <robot_state.h>

Inheritance diagram for urcl::primary_interface::RobotState:

Public Member Functions
virtual bool	consumeWith (AbstractPrimaryConsumer &consumer)
	Consume this specific package with a specific consumer. More...
virtual bool	parseWith (comm::BinParser &bp)
	Sets the attributes of the package by parsing a serialized representation of the package. More...
	RobotState ()=delete
	RobotState (const RobotStateType type)
	Creates a new RobotState object, setting the type of state message. More...
virtual std::string	toString () const
	Produces a human readable representation of the package object. More...
virtual	~RobotState ()=default
Public Member Functions inherited from urcl::primary_interface::PrimaryPackage
	PrimaryPackage ()
	Creates a new PrimaryPackage object. More...
virtual	~PrimaryPackage ()=default
Public Member Functions inherited from urcl::comm::URPackage< PackageHeader >
	URPackage ()=default
	Creates a new URPackage object. More...
virtual	~URPackage ()=default

Private Attributes
RobotStateType	state_type_

Additional Inherited Members
Public Types inherited from urcl::comm::URPackage< PackageHeader >
using	HeaderType = PackageHeader
Protected Attributes inherited from urcl::primary_interface::PrimaryPackage
std::unique_ptr< uint8_t >	buffer_
size_t	buffer_length_

Detailed Description

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

Definition at line 59 of file robot_state.h.

Constructor & Destructor Documentation

RobotState() [1/2]

urcl::primary_interface::RobotState::RobotState ( )

delete

RobotState() [2/2]

urcl::primary_interface::RobotState::RobotState ( const RobotStateType  type )

inline

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

Parameters

type	The type of state message

Definition at line 68 of file robot_state.h.

~RobotState()

virtual urcl::primary_interface::RobotState::~RobotState ( )

virtualdefault

Member Function Documentation

consumeWith()

bool urcl::primary_interface::RobotState::consumeWith ( AbstractPrimaryConsumer &  consumer )

virtual

Consume this specific package with a specific consumer.

Parameters

consumer

Placeholder for the consumer calling this

Returns

true on success

Implements urcl::primary_interface::PrimaryPackage.

Reimplemented in urcl::primary_interface::KinematicsInfo.

Definition at line 42 of file robot_state.cpp.

parseWith()

bool urcl::primary_interface::RobotState::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::primary_interface::PrimaryPackage.

Reimplemented in urcl::primary_interface::KinematicsInfo.

Definition at line 37 of file robot_state.cpp.

toString()

std::string urcl::primary_interface::RobotState::toString ( ) const

virtual

Produces a human readable representation of the package object.

Returns

A string representing the object

Reimplemented from urcl::primary_interface::PrimaryPackage.

Reimplemented in urcl::primary_interface::KinematicsInfo.

Definition at line 47 of file robot_state.cpp.

Member Data Documentation

state_type_

RobotStateType urcl::primary_interface::RobotState::state_type_

private

Definition at line 100 of file robot_state.h.

---

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

• robot_state.h
• robot_state.cpp