urcl::rtde_interface::RTDEPackage Class Reference

#include <rtde_package.h>

Inheritance diagram for urcl::rtde_interface::RTDEPackage:

Public Member Functions
virtual bool	parseWith (comm::BinParser &bp)
	Sets the attributes of the package by parsing a serialized representation of the package. More...
	RTDEPackage ()=delete
	Creates a new RTDEPackage object. More...
	RTDEPackage (const PackageType type)
virtual std::string	toString () const
	Produces a human readable representation of the package object. More...
virtual	~RTDEPackage ()=default
Public Member Functions inherited from urcl::comm::URPackage< PackageHeader >
	URPackage ()=default
	Creates a new URPackage object. More...
virtual	~URPackage ()=default

Protected Attributes
std::unique_ptr< uint8_t >	buffer_
size_t	buffer_length_
PackageType	type_

Additional Inherited Members
Public Types inherited from urcl::comm::URPackage< PackageHeader >
using	HeaderType = PackageHeader

Detailed Description

brief The RTDEPackage is solely an abstraction level. It inherits form the URPackage and is also a parent class for rtde_interface::TextMessage.

Definition at line 42 of file rtde_package.h.

Constructor & Destructor Documentation

urcl::rtde_interface::RTDEPackage::RTDEPackage ( )

delete

Creates a new RTDEPackage object.

urcl::rtde_interface::RTDEPackage::RTDEPackage ( const PackageType  type )

inline

Definition at line 49 of file rtde_package.h.

virtual urcl::rtde_interface::RTDEPackage::~RTDEPackage ( )

virtualdefault

Member Function Documentation

bool urcl::rtde_interface::RTDEPackage::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

Implements urcl::comm::URPackage< PackageHeader >.

Reimplemented in urcl::rtde_interface::DataPackage, urcl::rtde_interface::ControlPackageSetupOutputs, 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.

Definition at line 33 of file rtde_package.cpp.

std::string urcl::rtde_interface::RTDEPackage::toString ( ) const

virtual

Produces a human readable representation of the package object.

Returns

A string representing the object

Implements urcl::comm::URPackage< PackageHeader >.

Reimplemented in urcl::rtde_interface::DataPackage, urcl::rtde_interface::ControlPackageSetupOutputs, 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.

Definition at line 39 of file rtde_package.cpp.

Member Data Documentation

std::unique_ptr<uint8_t> urcl::rtde_interface::RTDEPackage::buffer_

protected

Definition at line 71 of file rtde_package.h.

size_t urcl::rtde_interface::RTDEPackage::buffer_length_

protected

Definition at line 72 of file rtde_package.h.

PackageType urcl::rtde_interface::RTDEPackage::type_

protected

Definition at line 73 of file rtde_package.h.

---

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

• rtde_package.h
• rtde_package.cpp