Public Member Functions | Protected Member Functions | Private Attributes | List of all members
vesc_driver::VescPacket Class Reference

#include <vesc_packet.h>

Inheritance diagram for vesc_driver::VescPacket:
Inheritance graph
[legend]

Public Member Functions

virtual const std::string & name () const
 
virtual ~VescPacket ()
 
- Public Member Functions inherited from vesc_driver::VescFrame
virtual const Bufferframe () const
 
virtual ~VescFrame ()
 

Protected Member Functions

 VescPacket (const std::string &name, int payload_size, int payload_id)
 
 VescPacket (const std::string &name, std::shared_ptr< VescFrame > raw)
 
- Protected Member Functions inherited from vesc_driver::VescFrame
 VescFrame (int payload_size)
 

Private Attributes

std::string name_
 

Additional Inherited Members

- Static Public Attributes inherited from vesc_driver::VescFrame
static constexpr CRC::Parameters< crcpp_uint16, 16 > CRC_TYPE = { 0x1021, 0x0000, 0x0000, false, false }
 
static const unsigned int VESC_EOF_VAL = 3
 VESC end-of-frame value. More...
 
static const int VESC_MAX_FRAME_SIZE = 6 + VESC_MAX_PAYLOAD_SIZE
 Largest VESC frame size, in bytes. More...
 
static const int VESC_MAX_PAYLOAD_SIZE = 1024
 Maximum VESC payload size, in bytes. More...
 
static const int VESC_MIN_FRAME_SIZE = 5
 Smallest VESC frame size, in bytes. More...
 
static const unsigned int VESC_SOF_VAL_LARGE_FRAME = 3
 VESC start of "large" frame value. More...
 
static const unsigned int VESC_SOF_VAL_SMALL_FRAME = 2
 VESC start of "small" frame value. More...
 
- Protected Attributes inherited from vesc_driver::VescFrame
std::shared_ptr< Bufferframe_
 Stores frame data, shared_ptr for shallow copy. More...
 
BufferRange payload_
 View into frame's payload section. More...
 

Detailed Description

A VescPacket is a VescFrame with a non-zero length payload

Definition at line 88 of file vesc_packet.h.

Constructor & Destructor Documentation

virtual vesc_driver::VescPacket::~VescPacket ( )
inlinevirtual

Definition at line 91 of file vesc_packet.h.

vesc_driver::VescPacket::VescPacket ( const std::string &  name,
int  payload_size,
int  payload_id 
)
protected

Definition at line 84 of file vesc_packet.cpp.

vesc_driver::VescPacket::VescPacket ( const std::string &  name,
std::shared_ptr< VescFrame raw 
)
protected

Definition at line 92 of file vesc_packet.cpp.

Member Function Documentation

virtual const std::string& vesc_driver::VescPacket::name ( ) const
inlinevirtual

Definition at line 93 of file vesc_packet.h.

Member Data Documentation

std::string vesc_driver::VescPacket::name_
private

Definition at line 103 of file vesc_packet.h.


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


vesc_driver
Author(s): Michael T. Boulet , Joshua Whitley
autogenerated on Sun Apr 18 2021 02:48:01