1
0
mirror of https://gitlab.com/obbart/universal_robots_ros_driver.git synced 2026-04-12 11:00:47 +02:00

added documentation for parser and higher level packages

This commit is contained in:
Lea Steffen
2019-04-09 15:40:23 +02:00
committed by Tristan Schnell
parent d32f66473e
commit 2f0b8eae1a
4 changed files with 36 additions and 0 deletions

View File

@@ -25,10 +25,22 @@ namespace ur_driver
{
namespace comm
{
/*!
* \brief The parser is a general paser. The namsepace rtde_interface and primary_interface both
* iclude classes which inherit from it (rtdeParser and primaryParser).
* The parser functionality also embodies a factory function taking in an uint8.
*/
template <typename HeaderT>
class Parser
{
public:
/*!
* \brief declares the parse function.
*
* \param bp instant of class binaryParser
* \param results unique pointer
*/
virtual bool parse(BinParser& bp, std::vector<std::unique_ptr<URPackage<HeaderT>>>& results) = 0;
using _header_type = HeaderT;