urcl::comm::URPackage< HeaderT > Class Template Reference

The URPackage a parent class. From that two implementations are inherited, one for the primary, one for the rtde interface (primary_interface::primaryPackage; rtde_interface::rtdePackage). The URPackage makes use of the template HeaderT. More...

#include <package.h>

Public Types
using	HeaderType = HeaderT

Public Member Functions
virtual bool	parseWith (BinParser &bp)=0
	Sets the attributes of the package by parsing a serialized representation of the package. More...
virtual std::string	toString () const =0
	Produces a human readable representation of the package object. More...
	URPackage ()=default
	Creates a new URPackage object. More...
virtual	~URPackage ()=default

Private Attributes
HeaderT	header_

Detailed Description

template<typename HeaderT>
class urcl::comm::URPackage< HeaderT >

The URPackage a parent class. From that two implementations are inherited, one for the primary, one for the rtde interface (primary_interface::primaryPackage; rtde_interface::rtdePackage). The URPackage makes use of the template HeaderT.

Definition at line 42 of file package.h.

Member Typedef Documentation

template<typename HeaderT>

using urcl::comm::URPackage< HeaderT >::HeaderType = HeaderT

Definition at line 69 of file package.h.

Constructor & Destructor Documentation

template<typename HeaderT>

urcl::comm::URPackage< HeaderT >::URPackage ( )

default

Creates a new URPackage object.

template<typename HeaderT>

virtual urcl::comm::URPackage< HeaderT >::~URPackage ( )

virtualdefault

Member Function Documentation

template<typename HeaderT>

virtual bool urcl::comm::URPackage< HeaderT >::parseWith ( BinParser &  bp )

pure 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

Implemented in urcl::rtde_interface::DataPackage, urcl::primary_interface::RobotState, urcl::primary_interface::RobotMessage, urcl::primary_interface::PrimaryPackage, urcl::primary_interface::KinematicsInfo, urcl::primary_interface::VersionMessage, urcl::rtde_interface::ControlPackageSetupOutputs, urcl::rtde_interface::RTDEPackage, urcl::rtde_interface::TextMessage, urcl::rtde_interface::ControlPackageSetupInputs, urcl::rtde_interface::ControlPackagePause, urcl::rtde_interface::ControlPackageStart, urcl::rtde_interface::GetUrcontrolVersion, and urcl::rtde_interface::RequestProtocolVersion.

template<typename HeaderT>

virtual std::string urcl::comm::URPackage< HeaderT >::toString ( ) const

pure virtual

Produces a human readable representation of the package object.

Returns

A string representing the object

Implemented in urcl::rtde_interface::DataPackage, urcl::primary_interface::RobotState, urcl::primary_interface::RobotMessage, urcl::primary_interface::PrimaryPackage, urcl::primary_interface::KinematicsInfo, urcl::primary_interface::VersionMessage, urcl::rtde_interface::ControlPackageSetupOutputs, urcl::rtde_interface::RTDEPackage, urcl::rtde_interface::TextMessage, urcl::rtde_interface::ControlPackageSetupInputs, urcl::rtde_interface::ControlPackagePause, urcl::rtde_interface::ControlPackageStart, urcl::rtde_interface::GetUrcontrolVersion, and urcl::rtde_interface::RequestProtocolVersion.

Member Data Documentation

template<typename HeaderT>

HeaderT urcl::comm::URPackage< HeaderT >::header_

private

Definition at line 72 of file package.h.

---

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

• package.h