Public Types | Public Member Functions | Static Public Member Functions | List of all members
clearpath::DataDifferentialSpeed Class Reference

#include <Message_data.h>

Inheritance diagram for clearpath::DataDifferentialSpeed:
Inheritance graph
[legend]

Public Types

enum  payloadOffsets {
  LEFT_SPEED = 0, RIGHT_SPEED = 2, LEFT_ACCEL = 4, RIGHT_ACCEL = 6,
  PAYLOAD_LEN = 8
}
 

Public Member Functions

 DataDifferentialSpeed (void *input, size_t msg_len)
 
 DataDifferentialSpeed (const DataDifferentialSpeed &other)
 
double getLeftAccel ()
 
double getLeftSpeed ()
 
double getRightAccel ()
 
double getRightSpeed ()
 
virtual std::ostream & printMessage (std::ostream &stream=std::cout)
 
- Public Member Functions inherited from clearpath::Message
uint16_t getChecksum ()
 
uint8_t getFlags ()
 
uint8_t getLength ()
 
uint8_t getLengthComp ()
 
size_t getPayload (void *buf, size_t max_size)
 
size_t getPayloadLength ()
 
uint32_t getTimestamp ()
 
size_t getTotalLength ()
 
uint16_t getType ()
 
uint8_t getVersion ()
 
bool isCommand ()
 
bool isData ()
 
bool isRequest ()
 
bool isValid (char *whyNot=NULL, size_t strLen=0)
 
 Message ()
 
 Message (void *input, size_t msg_len)
 
 Message (const Message &other)
 
 Message (uint16_t type, uint8_t *payload, size_t payload_len, uint32_t timestamp=0, uint8_t flags=0, uint8_t version=0)
 
void printRaw (std::ostream &stream=std::cout)
 
void send ()
 
size_t toBytes (void *buf, size_t buf_size)
 
virtual ~Message ()
 

Static Public Member Functions

static enum MessageTypes getTypeID ()
 
static DataDifferentialSpeedgetUpdate (double timeout=0)
 
static DataDifferentialSpeedpopNext ()
 
static void subscribe (uint16_t freq)
 
static DataDifferentialSpeedwaitNext (double timeout=0)
 
- Static Public Member Functions inherited from clearpath::Message
static Messagefactory (void *input, size_t msg_len)
 
static MessagepopNext ()
 
static MessagewaitNext (double timeout=0.0)
 

Additional Inherited Members

- Static Public Attributes inherited from clearpath::Message
static const size_t MAX_MSG_LENGTH = 256
 
static const size_t MIN_MSG_LENGTH = HEADER_LENGTH + CRC_LENGTH
 
static const uint8_t SOH = 0xAA
 
static const uint8_t STX = 0x55
 
- Protected Types inherited from clearpath::Message
enum  dataOffsets {
  SOH_OFST = 0, LENGTH_OFST, LENGTH_COMP_OFST, VERSION_OFST,
  TIMESTAMP_OFST, FLAGS_OFST = 8, TYPE_OFST, STX_OFST = 11,
  PAYLOAD_OFST
}
 
- Protected Member Functions inherited from clearpath::Message
size_t crcOffset ()
 
uint8_t * getPayloadPointer (size_t offset=0)
 
void makeValid ()
 
void setFlags (uint8_t flags)
 
void setLength (uint8_t len)
 
void setPayload (void *buf, size_t buf_size)
 
void setPayloadLength (uint8_t len)
 
void setTimestamp (uint32_t timestamp)
 
void setType (uint16_t type)
 
void setVersion (uint8_t version)
 
- Protected Attributes inherited from clearpath::Message
uint8_t data [MAX_MSG_LENGTH]
 
bool is_sent
 
size_t total_len
 
- Static Protected Attributes inherited from clearpath::Message
static const uint16_t CRC_INIT_VAL = 0xFFFF
 
static const size_t CRC_LENGTH = 2
 
static const size_t HEADER_LENGTH = 12
 

Detailed Description

Definition at line 187 of file Message_data.h.

Member Enumeration Documentation

◆ payloadOffsets

Enumerator
LEFT_SPEED 
RIGHT_SPEED 
LEFT_ACCEL 
RIGHT_ACCEL 
PAYLOAD_LEN 

Definition at line 190 of file Message_data.h.

Constructor & Destructor Documentation

◆ DataDifferentialSpeed() [1/2]

clearpath::DataDifferentialSpeed::DataDifferentialSpeed ( void *  input,
size_t  msg_len 
)

◆ DataDifferentialSpeed() [2/2]

clearpath::DataDifferentialSpeed::DataDifferentialSpeed ( const DataDifferentialSpeed other)

Member Function Documentation

◆ getLeftAccel()

double clearpath::DataDifferentialSpeed::getLeftAccel ( )

Definition at line 214 of file Message_data.cpp.

◆ getLeftSpeed()

double clearpath::DataDifferentialSpeed::getLeftSpeed ( )

Definition at line 209 of file Message_data.cpp.

◆ getRightAccel()

double clearpath::DataDifferentialSpeed::getRightAccel ( )

Definition at line 224 of file Message_data.cpp.

◆ getRightSpeed()

double clearpath::DataDifferentialSpeed::getRightSpeed ( )

Definition at line 219 of file Message_data.cpp.

◆ getTypeID()

static enum MessageTypes clearpath::DataDifferentialSpeed::getTypeID ( )
static

◆ getUpdate()

static DataDifferentialSpeed* clearpath::DataDifferentialSpeed::getUpdate ( double  timeout = 0)
static

◆ popNext()

static DataDifferentialSpeed* clearpath::DataDifferentialSpeed::popNext ( )
static

◆ printMessage()

ostream & clearpath::DataDifferentialSpeed::printMessage ( std::ostream &  stream = std::cout)
virtual

Reimplemented from clearpath::Message.

Definition at line 229 of file Message_data.cpp.

◆ subscribe()

static void clearpath::DataDifferentialSpeed::subscribe ( uint16_t  freq)
static

◆ waitNext()

static DataDifferentialSpeed* clearpath::DataDifferentialSpeed::waitNext ( double  timeout = 0)
static

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


husky_base
Author(s): Mike Purvis , Paul Bovbel
autogenerated on Sat Nov 26 2022 03:56:48