Public Member Functions | Public Attributes | List of all members
driver_svh::SVHSerialPacket Struct Reference

The SerialPacket holds the (non generated) header and data of one message to the SVH-Hardware. More...

#include <SVHSerialPacket.h>

Public Member Functions

bool operator== (const SVHSerialPacket &other) const
 Compares two SVHSerialPackets objects. More...
 
 SVHSerialPacket (size_t data_length=0, uint8_t address=SVH_GET_CONTROL_FEEDBACK)
 SVHSerialPacket contains the send and received data in raw format (bytewise) More...
 

Public Attributes

uint8_t address
 Adress denotes the actual function of the package. More...
 
std::vector< uint8_t > data
 Payload of the package. More...
 
uint8_t index
 Continuosly incremented counter per package. More...
 

Detailed Description

The SerialPacket holds the (non generated) header and data of one message to the SVH-Hardware.

Definition at line 80 of file SVHSerialPacket.h.

Constructor & Destructor Documentation

◆ SVHSerialPacket()

driver_svh::SVHSerialPacket::SVHSerialPacket ( size_t  data_length = 0,
uint8_t  address = SVH_GET_CONTROL_FEEDBACK 
)
inline

SVHSerialPacket contains the send and received data in raw format (bytewise)

Parameters
data_lengthinitial size to set the data length to. NOTE: To deserialize a packet this value HAS TO BE SET!

Definition at line 96 of file SVHSerialPacket.h.

Member Function Documentation

◆ operator==()

bool driver_svh::SVHSerialPacket::operator== ( const SVHSerialPacket other) const
inline

Compares two SVHSerialPackets objects.

Definition at line 103 of file SVHSerialPacket.h.

Member Data Documentation

◆ address

uint8_t driver_svh::SVHSerialPacket::address

Adress denotes the actual function of the package.

Definition at line 87 of file SVHSerialPacket.h.

◆ data

std::vector<uint8_t> driver_svh::SVHSerialPacket::data

Payload of the package.

Definition at line 89 of file SVHSerialPacket.h.

◆ index

uint8_t driver_svh::SVHSerialPacket::index

Continuosly incremented counter per package.

Note
Continuous counter is currently not used by this software, the hw will just copy the send counter back to the response

Definition at line 85 of file SVHSerialPacket.h.


The documentation for this struct was generated from the following file:


schunk_svh_library
Author(s): Georg Heppner, Lars Pfotzer, Felix Exner, Johannes Mangler, Stefan Scherzinger, Pascal Becker
autogenerated on Fri Apr 14 2023 02:53:52