DESERT 3.6.1
Loading...
Searching...
No Matches
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>

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.

Definition at line 56 of file uwranging_tokenbus_hdr.h.

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

Definition at line 113 of file uwranging_tokenbus_hdr.h.

◆ getSize()

size_t hdr_uwranging_tokenbus::getSize ( ) const
inline

Returns the size of this header.

Returns
the size of this header

Definition at line 93 of file uwranging_tokenbus_hdr.h.

◆ offset()

static int & hdr_uwranging_tokenbus::offset ( )
inlinestatic

Returns a reference to the offset_ variable.

Returns
a reference to the offset_ variable

Definition at line 102 of file uwranging_tokenbus_hdr.h.

◆ 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

Definition at line 67 of file uwranging_tokenbus_hdr.h.

◆ token_hold()

uwrange_time_t & hdr_uwranging_tokenbus::token_hold ( )
inline

Returns a reference to token_hold_ value.

Returns
a reference to token_hold_

Definition at line 76 of file uwranging_tokenbus_hdr.h.

◆ token_resend()

bool & hdr_uwranging_tokenbus::token_resend ( )
inline

Returns a reference to token_resend_.

Returns
a reference to token_resend_

Definition at line 85 of file uwranging_tokenbus_hdr.h.

Member Data Documentation

◆ offset_

int hdr_uwranging_tokenbus::offset_ = 0
static

Required by the PacketHeaderManager.

Definition at line 58 of file uwranging_tokenbus_hdr.h.

◆ times_

std::vector<uwrange_time_t> hdr_uwranging_tokenbus::times_

Holds the times calculated by the node.

Definition at line 60 of file uwranging_tokenbus_hdr.h.

◆ token_hold_

uwrange_time_t hdr_uwranging_tokenbus::token_hold_

time elapsed from token rx and token pass

Definition at line 59 of file uwranging_tokenbus_hdr.h.

◆ token_resend_

bool hdr_uwranging_tokenbus::token_resend_ = false

flag set if token is retransmitted when TokenPass timer expires

Definition at line 61 of file uwranging_tokenbus_hdr.h.

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