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

#include <transfer.hpp>

Public Member Functions

uint8_t get () const
 
bool isBroadcast () const
 
bool isUnicast () const
 
bool isValid () const
 
 NodeID ()
 
 NodeID (uint8_t value)
 
bool operator!= (NodeID rhs) const
 
bool operator< (NodeID rhs) const
 
bool operator<= (NodeID rhs) const
 
bool operator== (NodeID rhs) const
 
bool operator> (NodeID rhs) const
 
bool operator>= (NodeID rhs) const
 

Static Public Attributes

static const uint8_t BitLen = 7U
 
static const NodeID Broadcast
 
static const uint8_t Max = (1U << BitLen) - 1U
 
static const uint8_t MaxRecommendedForRegularNodes = Max - 2
 

Private Attributes

uint8_t value_
 

Static Private Attributes

static const uint8_t ValueBroadcast = 0
 
static const uint8_t ValueInvalid = 0xFF
 

Detailed Description

Definition at line 112 of file transfer.hpp.

Constructor & Destructor Documentation

◆ NodeID() [1/2]

uavcan::NodeID::NodeID ( )
inline

Definition at line 124 of file transfer.hpp.

◆ NodeID() [2/2]

uavcan::NodeID::NodeID ( uint8_t  value)
inline

Definition at line 126 of file transfer.hpp.

Member Function Documentation

◆ get()

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

Definition at line 132 of file transfer.hpp.

◆ isBroadcast()

bool uavcan::NodeID::isBroadcast ( ) const
inline

Definition at line 135 of file transfer.hpp.

◆ isUnicast()

bool uavcan::NodeID::isUnicast ( ) const
inline

Definition at line 136 of file transfer.hpp.

◆ isValid()

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

Definition at line 134 of file transfer.hpp.

◆ operator!=()

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

Definition at line 138 of file transfer.hpp.

◆ operator<()

bool uavcan::NodeID::operator< ( NodeID  rhs) const
inline

Definition at line 141 of file transfer.hpp.

◆ operator<=()

bool uavcan::NodeID::operator<= ( NodeID  rhs) const
inline

Definition at line 143 of file transfer.hpp.

◆ operator==()

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

Definition at line 139 of file transfer.hpp.

◆ operator>()

bool uavcan::NodeID::operator> ( NodeID  rhs) const
inline

Definition at line 142 of file transfer.hpp.

◆ operator>=()

bool uavcan::NodeID::operator>= ( NodeID  rhs) const
inline

Definition at line 144 of file transfer.hpp.

Member Data Documentation

◆ BitLen

const uint8_t uavcan::NodeID::BitLen = 7U
static

Definition at line 119 of file transfer.hpp.

◆ Broadcast

const NodeID uavcan::NodeID::Broadcast
static

Definition at line 122 of file transfer.hpp.

◆ Max

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

Definition at line 120 of file transfer.hpp.

◆ MaxRecommendedForRegularNodes

const uint8_t uavcan::NodeID::MaxRecommendedForRegularNodes = Max - 2
static

Definition at line 121 of file transfer.hpp.

◆ value_

uint8_t uavcan::NodeID::value_
private

Definition at line 116 of file transfer.hpp.

◆ ValueBroadcast

const uint8_t uavcan::NodeID::ValueBroadcast = 0
staticprivate

NodeID

Definition at line 114 of file transfer.hpp.

◆ ValueInvalid

const uint8_t uavcan::NodeID::ValueInvalid = 0xFF
staticprivate

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