Public Types | Public Member Functions
segway::RmpTransport Class Reference

#include <RmpTransport.h>

Inheritance diagram for segway::RmpTransport:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::shared_ptr
< RmpTransport
Ptr

Public Member Functions

virtual bool Receive (Bytes &rData, size_t size)=0
virtual bool Send (uint16_t commandId, uint32_t value1, uint32_t value2)=0
virtual ~RmpTransport ()

Detailed Description

This class is an abstract base class. It represents a communication transport between a host and a Rmp.

Definition at line 52 of file RmpTransport.h.


Member Typedef Documentation

typedef std::shared_ptr<RmpTransport> segway::RmpTransport::Ptr

Definition at line 55 of file RmpTransport.h.


Constructor & Destructor Documentation

virtual segway::RmpTransport::~RmpTransport ( ) [inline, virtual]

Destructor

Definition at line 60 of file RmpTransport.h.


Member Function Documentation

virtual bool segway::RmpTransport::Receive ( Bytes rData,
size_t  size 
) [pure virtual]

Receive response from rmp

Parameters:
rDataresponse
sizeexpected size of data to receive [in byte]
Returns:
wether the data were properly received

Implemented in segway::RmpUdp, and segway::RmpUsb.

virtual bool segway::RmpTransport::Send ( uint16_t  commandId,
uint32_t  value1,
uint32_t  value2 
) [pure virtual]

Send command to rmp

Parameters:
commandIdcommand id
value1first value
value2second value
Returns:
wether the command was properly sent

Implemented in segway::RmpUdp, and segway::RmpUsb.


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


rmp_base
Author(s):
autogenerated on Wed Aug 26 2015 16:24:40