Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
clearpath::DataEncoders Class Reference

#include <Message_data.h>

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

Public Member Functions

 DataEncoders (void *input, size_t msg_len)
 
 DataEncoders (const DataEncoders &other)
 
uint8_t getCount ()
 
double getSpeed (uint8_t index)
 
double getTravel (uint8_t index)
 
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 DataEncodersgetUpdate (double timeout=0)
 
static DataEncoderspopNext ()
 
static void subscribe (uint16_t freq)
 
static DataEncoderswaitNext (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)
 

Private Attributes

size_t speeds_offset
 
size_t travels_offset
 

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 245 of file Message_data.h.

Constructor & Destructor Documentation

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

Definition at line 252 of file Message_data.cpp.

clearpath::DataEncoders::DataEncoders ( const DataEncoders other)

Definition at line 265 of file Message_data.cpp.

Member Function Documentation

uint8_t clearpath::DataEncoders::getCount ( )

Definition at line 271 of file Message_data.cpp.

double clearpath::DataEncoders::getSpeed ( uint8_t  index)

Definition at line 281 of file Message_data.cpp.

double clearpath::DataEncoders::getTravel ( uint8_t  index)

Definition at line 276 of file Message_data.cpp.

static enum MessageTypes clearpath::DataEncoders::getTypeID ( )
static
static DataEncoders* clearpath::DataEncoders::getUpdate ( double  timeout = 0)
static
static DataEncoders* clearpath::DataEncoders::popNext ( )
static
ostream & clearpath::DataEncoders::printMessage ( std::ostream &  stream = std::cout)
virtual

Reimplemented from clearpath::Message.

Definition at line 286 of file Message_data.cpp.

static void clearpath::DataEncoders::subscribe ( uint16_t  freq)
static
static DataEncoders* clearpath::DataEncoders::waitNext ( double  timeout = 0)
static

Member Data Documentation

size_t clearpath::DataEncoders::speeds_offset
private

Definition at line 249 of file Message_data.h.

size_t clearpath::DataEncoders::travels_offset
private

Definition at line 248 of file Message_data.h.


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


husky_base
Author(s): Mike Purvis , Paul Bovbel
autogenerated on Fri Oct 2 2020 03:40:07