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

#include <Message_data.h>

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

Public Types

enum  payloadOffsets { ROLL = 0, PITCH = 2, YAW = 4, PAYLOAD_LEN = 6 }
 

Public Member Functions

 DataPlatformOrientation (void *input, size_t msg_len)
 
 DataPlatformOrientation (const DataPlatformOrientation &other)
 
double getPitch ()
 
double getRoll ()
 
double getYaw ()
 
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 DataPlatformOrientationgetUpdate (double timeout=0)
 
static DataPlatformOrientationpopNext ()
 
static void subscribe (uint16_t freq)
 
static DataPlatformOrientationwaitNext (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 580 of file Message_data.h.

Member Enumeration Documentation

Enumerator
ROLL 
PITCH 
YAW 
PAYLOAD_LEN 

Definition at line 583 of file Message_data.h.

Constructor & Destructor Documentation

clearpath::DataPlatformOrientation::DataPlatformOrientation ( void *  input,
size_t  msg_len 
)
clearpath::DataPlatformOrientation::DataPlatformOrientation ( const DataPlatformOrientation other)

Member Function Documentation

double clearpath::DataPlatformOrientation::getPitch ( )

Definition at line 582 of file Message_data.cpp.

double clearpath::DataPlatformOrientation::getRoll ( )

Definition at line 577 of file Message_data.cpp.

static enum MessageTypes clearpath::DataPlatformOrientation::getTypeID ( )
static
static DataPlatformOrientation* clearpath::DataPlatformOrientation::getUpdate ( double  timeout = 0)
static
double clearpath::DataPlatformOrientation::getYaw ( )

Definition at line 587 of file Message_data.cpp.

static DataPlatformOrientation* clearpath::DataPlatformOrientation::popNext ( )
static
ostream & clearpath::DataPlatformOrientation::printMessage ( std::ostream &  stream = std::cout)
virtual

Reimplemented from clearpath::Message.

Definition at line 592 of file Message_data.cpp.

static void clearpath::DataPlatformOrientation::subscribe ( uint16_t  freq)
static
static DataPlatformOrientation* clearpath::DataPlatformOrientation::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 Fri Oct 2 2020 03:40:07