urcl::rtde_interface::RTDEParser Class Reference

The RTDE specific parser. Interprets a given byte stream as serialized RTDE packages and parses it accordingly. More...

#include <rtde_parser.h>

Inheritance diagram for urcl::rtde_interface::RTDEParser:

Public Member Functions
bool	parse (comm::BinParser &bp, std::vector< std::unique_ptr< RTDEPackage >> &results)
	Uses the given BinParser to create package objects from the contained serialization. More...
	RTDEParser ()=delete
	RTDEParser (const std::vector< std::string > &recipe)
	Creates a new RTDEParser object, registering the used recipe. More...
void	setProtocolVersion (uint16_t protocol_version)
virtual	~RTDEParser ()=default
Public Member Functions inherited from urcl::comm::Parser< RTDEPackage >
virtual bool	parse (BinParser &bp, std::vector< std::unique_ptr< RTDEPackage >> &results)=0
	Declares the parse function. More...
	Parser ()=default
virtual	~Parser ()=default

Private Member Functions
RTDEPackage *	packageFromType (PackageType type)

Private Attributes
uint16_t	protocol_version_
std::vector< std::string >	recipe_

Detailed Description

The RTDE specific parser. Interprets a given byte stream as serialized RTDE packages and parses it accordingly.

Definition at line 45 of file rtde_parser.h.

Constructor & Destructor Documentation

RTDEParser() [1/2]

urcl::rtde_interface::RTDEParser::RTDEParser ( )

delete

RTDEParser() [2/2]

urcl::rtde_interface::RTDEParser::RTDEParser ( const std::vector< std::string > &  recipe )

inline

Creates a new RTDEParser object, registering the used recipe.

Parameters

recipe

The recipe used in RTDE data communication

Definition at line 54 of file rtde_parser.h.

~RTDEParser()

virtual urcl::rtde_interface::RTDEParser::~RTDEParser ( )

virtualdefault

Member Function Documentation

packageFromType()

RTDEPackage* urcl::rtde_interface::RTDEParser::packageFromType ( PackageType  type )

inlineprivate

Definition at line 126 of file rtde_parser.h.

parse()

bool urcl::rtde_interface::RTDEParser::parse ( comm::BinParser &  bp, std::vector< std::unique_ptr< RTDEPackage >> &  results  )

inline

Uses the given BinParser to create package objects from the contained serialization.

Parameters

bp	A BinParser holding one or more serialized RTDE packages
results	A vector of pointers to created RTDE package objects

Returns

True, if the byte stream could successfully be parsed as RTDE packages, false otherwise

Definition at line 68 of file rtde_parser.h.

setProtocolVersion()

void urcl::rtde_interface::RTDEParser::setProtocolVersion ( uint16_t  protocol_version )

inline

Definition at line 119 of file rtde_parser.h.

Member Data Documentation

protocol_version_

uint16_t urcl::rtde_interface::RTDEParser::protocol_version_

private

Definition at line 155 of file rtde_parser.h.

recipe_

std::vector<std::string> urcl::rtde_interface::RTDEParser::recipe_

private

Definition at line 125 of file rtde_parser.h.

---

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

• rtde_parser.h