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

#include <transfer.hpp>

Public Member Functions

uint8_t get () const
 
bool isValid () const
 
bool operator!= (TransferPriority rhs) const
 
bool operator== (TransferPriority rhs) const
 
 TransferPriority ()
 
 TransferPriority (uint8_t value)
 

Static Public Member Functions

template<uint8_t Percent>
static TransferPriority fromPercent ()
 

Static Public Attributes

static const uint8_t BitLen = 5U
 
static const TransferPriority Default
 This priority is used by default. More...
 
static const TransferPriority Lowest
 
static const TransferPriority MiddleLower
 
static const uint8_t NumericallyMax = (1U << BitLen) - 1
 
static const uint8_t NumericallyMin = 0
 
static const TransferPriority OneHigherThanLowest
 
static const TransferPriority OneLowerThanHighest
 

Private Attributes

uint8_t value_
 

Detailed Description

Definition at line 28 of file transfer.hpp.

Constructor & Destructor Documentation

◆ TransferPriority() [1/2]

uavcan::TransferPriority::TransferPriority ( )
inline

Definition at line 44 of file transfer.hpp.

◆ TransferPriority() [2/2]

uavcan::TransferPriority::TransferPriority ( uint8_t  value)
inline

Definition at line 46 of file transfer.hpp.

Member Function Documentation

◆ fromPercent()

template<uint8_t Percent>
static TransferPriority uavcan::TransferPriority::fromPercent ( )
inlinestatic

Definition at line 53 of file transfer.hpp.

◆ get()

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

Definition at line 62 of file transfer.hpp.

◆ isValid()

bool uavcan::TransferPriority::isValid ( ) const
inline

Definition at line 64 of file transfer.hpp.

◆ operator!=()

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

Definition at line 66 of file transfer.hpp.

◆ operator==()

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

Definition at line 67 of file transfer.hpp.

Member Data Documentation

◆ BitLen

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

TransferPriority

Definition at line 33 of file transfer.hpp.

◆ Default

const TransferPriority uavcan::TransferPriority::Default
static

This priority is used by default.

Definition at line 38 of file transfer.hpp.

◆ Lowest

const TransferPriority uavcan::TransferPriority::Lowest
static

Definition at line 42 of file transfer.hpp.

◆ MiddleLower

const TransferPriority uavcan::TransferPriority::MiddleLower
static

Definition at line 39 of file transfer.hpp.

◆ NumericallyMax

const uint8_t uavcan::TransferPriority::NumericallyMax = (1U << BitLen) - 1
static

Definition at line 34 of file transfer.hpp.

◆ NumericallyMin

const uint8_t uavcan::TransferPriority::NumericallyMin = 0
static

Definition at line 35 of file transfer.hpp.

◆ OneHigherThanLowest

const TransferPriority uavcan::TransferPriority::OneHigherThanLowest
static

Definition at line 40 of file transfer.hpp.

◆ OneLowerThanHighest

const TransferPriority uavcan::TransferPriority::OneLowerThanHighest
static

Definition at line 41 of file transfer.hpp.

◆ value_

uint8_t uavcan::TransferPriority::value_
private

Definition at line 30 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