Public Member Functions | Static Public Attributes | Private Attributes | List of all members
uavcan::TransferID Class Reference

#include <transfer.hpp>

Public Member Functions

int computeForwardDistance (TransferID rhs) const
 
uint8_t get () const
 
void increment ()
 
bool operator!= (TransferID rhs) const
 
bool operator== (TransferID rhs) const
 
 TransferID ()
 
 TransferID (uint8_t value)
 

Static Public Attributes

static const uint8_t BitLen = 5U
 
static const uint8_t Half = (1U << BitLen) / 2U
 
static const uint8_t Max = (1U << BitLen) - 1U
 

Private Attributes

uint8_t value_
 

Detailed Description

Definition at line 71 of file transfer.hpp.

Constructor & Destructor Documentation

◆ TransferID() [1/2]

uavcan::TransferID::TransferID ( )
inline

Definition at line 80 of file transfer.hpp.

◆ TransferID() [2/2]

uavcan::TransferID::TransferID ( uint8_t  value)
inline

Definition at line 84 of file transfer.hpp.

Member Function Documentation

◆ computeForwardDistance()

int uavcan::TransferID::computeForwardDistance ( TransferID  rhs) const

Amount of increment() calls to reach rhs value.

TransferID

Definition at line 44 of file uc_transfer.cpp.

◆ get()

uint8_t uavcan::TransferID::get ( ) const
inline

Definition at line 99 of file transfer.hpp.

◆ increment()

void uavcan::TransferID::increment ( )
inline

Definition at line 94 of file transfer.hpp.

◆ operator!=()

bool uavcan::TransferID::operator!= ( TransferID  rhs) const
inline

Definition at line 91 of file transfer.hpp.

◆ operator==()

bool uavcan::TransferID::operator== ( TransferID  rhs) const
inline

Definition at line 92 of file transfer.hpp.

Member Data Documentation

◆ BitLen

const uint8_t uavcan::TransferID::BitLen = 5U
static

TransferID

Definition at line 76 of file transfer.hpp.

◆ Half

const uint8_t uavcan::TransferID::Half = (1U << BitLen) / 2U
static

Definition at line 78 of file transfer.hpp.

◆ Max

const uint8_t uavcan::TransferID::Max = (1U << BitLen) - 1U
static

Definition at line 77 of file transfer.hpp.

◆ value_

uint8_t uavcan::TransferID::value_
private

Definition at line 73 of file transfer.hpp.


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


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:05