DESERT 4.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
hdr_uwranging_tokenbus Struct Reference

#include <uwranging_tokenbus_hdr.h>

Collaboration diagram for hdr_uwranging_tokenbus:
Collaboration graph

Public Member Functions

std::vector< uwrange_time_t > & times ()
 
uwrange_time_t & token_hold ()
 
bool & token_resend ()
 
size_t getSize () const
 

Static Public Member Functions

static int & offset ()
 
static struct hdr_uwranging_tokenbus * access (const Packet *p)
 

Public Attributes

uwrange_time_t token_hold_
 
std::vector< uwrange_time_t > times_
 
bool token_resend_ = false
 

Static Public Attributes

static int offset_ = 0
 

Detailed Description

Header of the token bus protocol

Member Function Documentation

◆ access()

static struct hdr_uwranging_tokenbus * hdr_uwranging_tokenbus::access ( const Packet *  p)
inlinestatic

Returns a pointer to the tokenbus_ranging header of a packet

Parameters
pPacket
Returns
a pointer to the tokenbus_ranging header of the packet p

References access(), and offset_.

Referenced by access().

Here is the call graph for this function:

◆ getSize()

size_t hdr_uwranging_tokenbus::getSize ( ) const
inline

Returns the size of this header

Returns
the size of this header

References times_.

Referenced by UwRangingTokenBus::sendToken().

◆ offset()

static int & hdr_uwranging_tokenbus::offset ( )
inlinestatic

Returns a reference to the offset_ variable

Returns
a reference to the offset_ variable

References offset_.

◆ times()

std::vector< uwrange_time_t > & hdr_uwranging_tokenbus::times ( )
inline

Returns a reference to the travel times array

Returns
a reference to the travel times array

References times_.

Referenced by UwRangingTokenBus::Phy2MacEndRx(), and UwRangingTokenBus::sendToken().

◆ token_hold()

uwrange_time_t & hdr_uwranging_tokenbus::token_hold ( )
inline

Returns a reference to token_hold_ value

Returns
a reference to token_hold_

References token_hold_.

Referenced by UwRangingTokenBus::Phy2MacEndRx(), and UwRangingTokenBus::sendToken().

◆ token_resend()

bool & hdr_uwranging_tokenbus::token_resend ( )
inline

Returns a reference to token_resend_

Returns
a reference to token_resend_

References token_resend_.

Referenced by UwRangingTokenBus::sendToken().

Member Data Documentation

◆ offset_

int hdr_uwranging_tokenbus::offset_ = 0
static

Required by the PacketHeaderManager.

Referenced by access(), and offset().

◆ times_

std::vector<uwrange_time_t> hdr_uwranging_tokenbus::times_

Holds the times calculated by the node

Referenced by getSize(), and times().

◆ token_hold_

uwrange_time_t hdr_uwranging_tokenbus::token_hold_

time elapsed from token rx and token pass

Referenced by token_hold().

◆ token_resend_

bool hdr_uwranging_tokenbus::token_resend_ = false

flag set if token is retransmitted when TokenPass timer expires

Referenced by token_resend().

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