Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
sawyer::DataFirmwareInfo Class Reference

#include <Message_data.h>

Inheritance diagram for sawyer::DataFirmwareInfo:
Inheritance graph
[legend]

Classes

class  WriteTime
 

Public Types

enum  payloadOffsets {
  MAJOR_FIRM_VER = 0, MINOR_FIRM_VER, MAJOR_PROTO_VER, MINOR_PROTO_VER,
  WRITE_TIME, PAYLOAD_LEN = 8
}
 

Public Member Functions

 DataFirmwareInfo (void *input, size_t msg_len)
 
 DataFirmwareInfo (const DataFirmwareInfo &other)
 
uint8_t getMajorFirmwareVersion ()
 
uint8_t getMajorProtocolVersion ()
 
uint8_t getMinorFirmwareVersion ()
 
uint8_t getMinorProtocolVersion ()
 
WriteTime getWriteTime ()
 
virtual std::ostream & printMessage (std::ostream &stream=std::cout)
 
- Public Member Functions inherited from sawyer::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 ()
 
size_t getTotalLength ()
 
uint16_t getType ()
 
size_t getType (void *buf, size_t max_size)
 
size_t getTypeLength ()
 
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 ()
 
MessagesendRequest ()
 
size_t toBytes (void *buf, size_t buf_size)
 
virtual ~Message ()
 

Static Public Member Functions

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

Additional Inherited Members

- Public Attributes inherited from sawyer::Message
uint8_t data [MAX_MSG_LENGTH]
 
size_t total_len
 
- Static Public Attributes inherited from sawyer::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 sawyer::Message
enum  dataOffsets {
  SOH_OFST = 0, LENGTH_OFST, LENGTH_COMP_OFST, VERSION_OFST,
  FLAGS_OFST = 4, STX_OFST = 5, TYPE_OFST, PAYLOAD_OFST =8
}
 
- Protected Member Functions inherited from sawyer::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 setType (uint16_t type)
 
void setVersion (uint8_t version)
 
- Protected Attributes inherited from sawyer::Message
bool is_sent
 
- Static Protected Attributes inherited from sawyer::Message
static const uint16_t CRC_INIT_VAL = 0xFFFF
 
static const size_t CRC_LENGTH = 2
 
static const size_t HEADER_LENGTH = 8
 

Detailed Description

Definition at line 305 of file Message_data.h.

Member Enumeration Documentation

Enumerator
MAJOR_FIRM_VER 
MINOR_FIRM_VER 
MAJOR_PROTO_VER 
MINOR_PROTO_VER 
WRITE_TIME 
PAYLOAD_LEN 

Definition at line 308 of file Message_data.h.

Constructor & Destructor Documentation

sawyer::DataFirmwareInfo::DataFirmwareInfo ( void *  input,
size_t  msg_len 
)
sawyer::DataFirmwareInfo::DataFirmwareInfo ( const DataFirmwareInfo other)

Member Function Documentation

uint8_t sawyer::DataFirmwareInfo::getMajorFirmwareVersion ( )

Definition at line 318 of file Message_data.cpp.

uint8_t sawyer::DataFirmwareInfo::getMajorProtocolVersion ( )

Definition at line 328 of file Message_data.cpp.

uint8_t sawyer::DataFirmwareInfo::getMinorFirmwareVersion ( )

Definition at line 323 of file Message_data.cpp.

uint8_t sawyer::DataFirmwareInfo::getMinorProtocolVersion ( )

Definition at line 333 of file Message_data.cpp.

static enum MessageTypes sawyer::DataFirmwareInfo::getTypeID ( )
static
static DataFirmwareInfo* sawyer::DataFirmwareInfo::getUpdate ( double  timeout = 0)
static
DataFirmwareInfo::WriteTime sawyer::DataFirmwareInfo::getWriteTime ( )

Definition at line 338 of file Message_data.cpp.

static DataFirmwareInfo* sawyer::DataFirmwareInfo::popNext ( )
static
ostream & sawyer::DataFirmwareInfo::printMessage ( std::ostream &  stream = std::cout)
virtual

Reimplemented from sawyer::Message.

Definition at line 343 of file Message_data.cpp.

static void sawyer::DataFirmwareInfo::subscribe ( uint16_t  freq)
static
static DataFirmwareInfo* sawyer::DataFirmwareInfo::waitNext ( double  timeout = 0)
static

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


roch_base
Author(s): Mike Purvis , Paul Bovbel , Chen
autogenerated on Mon Jun 10 2019 14:41:14