Public Member Functions | Private Member Functions | List of all members
urcl::primary_interface::PrimaryParser Class Reference

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

#include <primary_parser.h>

Inheritance diagram for urcl::primary_interface::PrimaryParser:
Inheritance graph
[legend]

Public Member Functions

bool parse (comm::BinParser &bp, std::vector< std::unique_ptr< PrimaryPackage >> &results)
 Uses the given BinParser to create package objects from the contained serialization. More...
 
 PrimaryParser ()=default
 
virtual ~PrimaryParser ()=default
 
- Public Member Functions inherited from urcl::comm::Parser< PrimaryPackage >
virtual bool parse (BinParser &bp, std::vector< std::unique_ptr< PrimaryPackage >> &results)=0
 Declares the parse function. More...
 
 Parser ()=default
 
virtual ~Parser ()=default
 

Private Member Functions

RobotMessagemessageFromType (RobotMessagePackageType type, uint64_t timestamp, uint8_t source)
 
RobotStatestateFromType (RobotStateType type)
 

Detailed Description

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

Definition at line 40 of file primary_parser.h.

Constructor & Destructor Documentation

urcl::primary_interface::PrimaryParser::PrimaryParser ( )
default
virtual urcl::primary_interface::PrimaryParser::~PrimaryParser ( )
virtualdefault

Member Function Documentation

RobotMessage* urcl::primary_interface::PrimaryParser::messageFromType ( RobotMessagePackageType  type,
uint64_t  timestamp,
uint8_t  source 
)
inlineprivate

Definition at line 165 of file primary_parser.h.

bool urcl::primary_interface::PrimaryParser::parse ( comm::BinParser bp,
std::vector< std::unique_ptr< PrimaryPackage >> &  results 
)
inline

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

Parameters
bpA BinParser holding one or more serialized primary packages
resultsA vector of pointers to created primary package objects
Returns
True, if the byte stream could successfully be parsed as primary packages, false otherwise

Definition at line 55 of file primary_parser.h.

RobotState* urcl::primary_interface::PrimaryParser::stateFromType ( RobotStateType  type)
inlineprivate

Definition at line 148 of file primary_parser.h.


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


ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Sun May 9 2021 02:16:26