#include <uwranging_tdoa.h>

Inheritance diagram for UwRangingTDOA:

Collaboration diagram for UwRangingTDOA:

Public Member Functions
	UwRangingTDOA ()

virtual	~UwRangingTDOA ()=default

virtual void	recv (Packet *) override

virtual void	recv (Packet p, Handler h) override

virtual int	recvSyncClMsg (ClMessage *m) override

virtual int	command (int argc, const char const argv) override

virtual void	start ()

virtual void	stop ()

Protected Member Functions
virtual bool	isValid (double value) const

virtual bool	isValid (const tdoa_entry &entry) const

virtual void	rangeTX ()

virtual void	rangeRX (const Packet *p)

virtual void	updateHoldoverTime (Packet *p, double tx_duration)

virtual int	calcOptEntries (std::vector< int > *sorted_entries=nullptr) const

virtual double	entryWeight (int entry, int pkt_size, int mode) const

virtual void	throttleTX ()

Protected Attributes
bool	scheduler_active

int	debug_tdoa

int	node_id

int	packet_id

int	n_nodes

int	dist_num

int	range_entries

int	poisson_traffic

int	range_pkts_sent

int	range_bytes_sent

int	range_pkts_recv

int	range_pkts_err

int	saved_entries

int	phy_id

int	queue_size

UwRangeTimer	send_timer

double	mac2phy_delay

double	max_tt

double	max_age

double	range_period

double	delay_start

double	full_pkt_tx_dur

double	soundspeed

std::vector< std::vector< int > >	tof_map

std::vector< std::vector< std::vector< tdoa_entry > > >	entries_mat

std::vector< std::vector< double > >	times_mat

std::vector< int >	last_ids

std::vector< double >	time_of_flights

std::vector< double >	entries_timestamps

std::vector< double >	entry_last_tx

std::vector< uwrange_time_t >	tx_timestamp

std::vector< double >	ber

const size_t	PKTIDMAX

Friends
class	UwRangeTimer

Detailed Description

Class that represents a UwRangingTDOA Node

Constructor & Destructor Documentation

◆ UwRangingTDOA()

UwRangingTDOA::UwRangingTDOA ( )

Constructor of the UwRangingTDOA class

References ber, debug_tdoa, delay_start, dist_num, entries_mat, entries_timestamps, entry_last_tx, last_ids, mac2phy_delay, max_tt, n_nodes, PKTIDMAX, poisson_traffic, range_entries, range_period, soundspeed, time_of_flights, times_mat, and tof_map.

◆ ~UwRangingTDOA()

virtual UwRangingTDOA::~UwRangingTDOA ( )

virtualdefault

Destructor of the UwRangingTDOA class

Member Function Documentation

◆ calcOptEntries()

int UwRangingTDOA::calcOptEntries ( std::vector< int > * sorted_entries = nullptr ) const

protectedvirtual

Compute the optimal number of entries for the ranging message.

Parameters

std::vector<int> Vector of entries to sort.

Returns: int Number of optimal entries.

References entryWeight(), hdr_ranging_tdoa::getSize(), n_nodes, node_id, and range_entries.

Referenced by command(), and rangeTX().

Here is the call graph for this function:

◆ command()

int UwRangingTDOA::command	(	int	argc,
		const char const	argv
	)

overridevirtual

TCL command interpreter. It implements the following OTcl methods:

Parameters

argc	Number of arguments in argv.
argv	Array of strings which are the command parameters

Returns: TCL_OK or TCL_ERROR

References calcOptEntries(), full_pkt_tx_dur, n_nodes, node_id, phy_id, range_bytes_sent, range_pkts_err, range_pkts_recv, range_pkts_sent, rangeTX(), saved_entries, start(), stop(), time_of_flights, and tof_map.

Here is the call graph for this function:

◆ entryWeight()

double UwRangingTDOA::entryWeight	(	int	entry,
		int	pkt_size,
		int	mode
	)		const

protectedvirtual

Compute the weight of the entry given the packet size in bits.

Parameters

int	n-th entries.
int	size of the n-th entries in bit
int	mode to use to compute the optimal number of entries

References ber, and entry_last_tx.

Referenced by calcOptEntries().

◆ isValid() [1/2]

bool UwRangingTDOA::isValid ( const tdoa_entry & entry ) const

protectedvirtual

Check if all elements of a tdoa entry are not negative.

Parameters

tdoa_entry Entry to check.

Returns: true if valid, false otherwise

References tdoa_entry::id, tdoa_entry::node, and tdoa_entry::time.

◆ isValid() [2/2]

bool UwRangingTDOA::isValid ( double value ) const

protectedvirtual

Check if value is not negative.

Parameters

double Value to check.

Returns: true if valid, false otherwise

Referenced by rangeRX(), and rangeTX().

◆ rangeRX()

void UwRangingTDOA::rangeRX ( const Packet * p )

protectedvirtual

References entries_mat, entries_timestamps, isValid(), last_ids, mac2phy_delay, max_age, max_tt, n_nodes, node_id, hdr_ranging_tdoa::source_node_id, hdr_ranging_tdoa::source_pkt_id, time_of_flights, times_mat, hdr_ranging_tdoa::times_size(), and tof_map.

Referenced by recvSyncClMsg().

Here is the call graph for this function:

◆ rangeTX()

void UwRangingTDOA::rangeTX ( )

protectedvirtual

Send a ranging message down to the MAC layer.

References calcOptEntries(), entries_mat, hdr_ranging_tdoa::getSize(), isValid(), last_ids, n_nodes, node_id, packet_id, PKTIDMAX, PT_UWRANGING_TDOA, queue_size, range_period, saved_entries, hdr_ranging_tdoa::source_node_id, hdr_ranging_tdoa::source_pkt_id, times_mat, hdr_ranging_tdoa::times_size_, and tx_timestamp.

Referenced by command(), and throttleTX().

Here is the call graph for this function:

◆ recv() [1/2]

void UwRangingTDOA::recv ( Packet * p )

overridevirtual

Performs the reception of packets from upper and lower layers.

Parameters

Packet* Pointer to the packet will be received.

References PT_UWRANGING_TDOA.

Referenced by recv().

◆ recv() [2/2]

void UwRangingTDOA::recv	(	Packet *	p,
		Handler *	h
	)

overridevirtual

Performs the reception of packets from upper and lower layers.

Parameters

Packet*	Pointer to the packet will be received.
Handler*	Handler.

References recv().

Here is the call graph for this function:

◆ recvSyncClMsg()

int UwRangingTDOA::recvSyncClMsg ( ClMessage * m )

overridevirtual

Retrieve packets from other modules

Parameters

m ClMessage

References ber, CLMSG_TAP_PKT, CLMSG_TRIGGER_STATS, ClMsgTapPkt::clmsg_type, END_RX, UwPhysicalStats::last_ber, phy_id, ClMsgTapPkt::pkt, PT_UWRANGING_TDOA, range_entries, range_pkts_err, range_pkts_recv, rangeRX(), hdr_ranging_tdoa::source_node_id, hdr_ranging_tdoa::source_pkt_id, START_TX, StatsEnum::STATS_PHY_LAYER, ClMsgTapPkt::tx_duration, and updateHoldoverTime().

Here is the call graph for this function:

◆ start()

void UwRangingTDOA::start ( )

virtual

Start to send packets.

References delay_start, node_id, scheduler_active, and send_timer.

Referenced by command().

◆ stop()

void UwRangingTDOA::stop ( )

virtual

Stop to send packets.

References scheduler_active, and send_timer.

Referenced by command().

◆ throttleTX()

void UwRangingTDOA::throttleTX ( )

protectedvirtual

Schedule the transmission of a rangig message.

References poisson_traffic, queue_size, range_period, rangeTX(), scheduler_active, and send_timer.

Here is the call graph for this function:

◆ updateHoldoverTime()

void UwRangingTDOA::updateHoldoverTime	(	Packet *	p,
		double	tx_duration
	)

protectedvirtual

Update the holdover time with the actual time of transmission.

Parameters

Packet*	Pointer to the packet received.
double	Transmission duration computed by the physical layer.

References entries_mat, entry_last_tx, full_pkt_tx_dur, hdr_ranging_tdoa::getSize(), mac2phy_delay, n_nodes, node_id, queue_size, range_bytes_sent, range_pkts_sent, hdr_ranging_tdoa::source_pkt_id, times_mat, hdr_ranging_tdoa::times_size(), and tx_timestamp.

Referenced by recvSyncClMsg().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ UwRangeTimer

friend class UwRangeTimer

friend

Member Data Documentation

◆ ber

std::vector<double> UwRangingTDOA::ber

protected

Referenced by entryWeight(), recvSyncClMsg(), and UwRangingTDOA().

◆ debug_tdoa

int UwRangingTDOA::debug_tdoa

protected

Referenced by UwRangingTDOA().

◆ delay_start

double UwRangingTDOA::delay_start

protected

Starting delay in seconds.

Referenced by start(), and UwRangingTDOA().

◆ dist_num

int UwRangingTDOA::dist_num

protected

Number of distances each node computes.

Referenced by UwRangingTDOA().

◆ entries_mat

std::vector<std::vector<std::vector<tdoa_entry> > > UwRangingTDOA::entries_mat

protected

Referenced by rangeRX(), rangeTX(), updateHoldoverTime(), and UwRangingTDOA().

◆ entries_timestamps

std::vector<double> UwRangingTDOA::entries_timestamps

protected

Referenced by rangeRX(), and UwRangingTDOA().

◆ entry_last_tx

std::vector<double> UwRangingTDOA::entry_last_tx

protected

Vector of the last (actual) TX times of each entry.

Referenced by entryWeight(), updateHoldoverTime(), and UwRangingTDOA().

◆ full_pkt_tx_dur

double UwRangingTDOA::full_pkt_tx_dur

protected

TX duration for a full range packet.

Referenced by command(), and updateHoldoverTime().

◆ last_ids

std::vector<int> UwRangingTDOA::last_ids

protected

Referenced by rangeRX(), rangeTX(), and UwRangingTDOA().

◆ mac2phy_delay

double UwRangingTDOA::mac2phy_delay

protected

Referenced by rangeRX(), updateHoldoverTime(), and UwRangingTDOA().

◆ max_age

double UwRangingTDOA::max_age

protected

Max age of a ranging packet in seconds.

Referenced by rangeRX().

◆ max_tt

double UwRangingTDOA::max_tt

protected

Floating numbers within this value won't be discarded by NNLS. Max travel time between nodes in seconds.

Referenced by rangeRX(), and UwRangingTDOA().

◆ n_nodes

int UwRangingTDOA::n_nodes

protected

Number of nodes.

Referenced by calcOptEntries(), command(), rangeRX(), rangeTX(), updateHoldoverTime(), and UwRangingTDOA().

◆ node_id

int UwRangingTDOA::node_id

protected

Id of the current node.

Referenced by calcOptEntries(), command(), rangeRX(), rangeTX(), start(), and updateHoldoverTime().

◆ packet_id

int UwRangingTDOA::packet_id

protected

id of the last ranging packet sent (= node_id + k*n_nodes)

Referenced by rangeTX().

◆ phy_id

int UwRangingTDOA::phy_id

protected

Id of the PHY module.

Referenced by command(), and recvSyncClMsg().

◆ PKTIDMAX

const size_t UwRangingTDOA::PKTIDMAX

protected

Initial value:

= std::numeric_limits<uwrange_pkt_t>::

max()

Max number of ranging packets that can be saved.

Referenced by rangeTX(), and UwRangingTDOA().

◆ poisson_traffic

int UwRangingTDOA::poisson_traffic

protected

If true the ranging packets are sent according to a poisson process with rate range_period.

Referenced by throttleTX(), and UwRangingTDOA().

◆ queue_size

int UwRangingTDOA::queue_size

protected

Counts the packet sent to the MAC waiting to be transmitted.

Referenced by rangeTX(), throttleTX(), and updateHoldoverTime().

◆ range_bytes_sent

int UwRangingTDOA::range_bytes_sent

protected

Counter of sent ranging bytes.

Referenced by command(), and updateHoldoverTime().

◆ range_entries

int UwRangingTDOA::range_entries

protected

Number of entries per ranging packet, if <= 0 enable adaptive payload size.

Referenced by calcOptEntries(), recvSyncClMsg(), and UwRangingTDOA().

◆ range_period

double UwRangingTDOA::range_period

protected

Ranging period in seconds.

Referenced by rangeTX(), throttleTX(), and UwRangingTDOA().

◆ range_pkts_err

int UwRangingTDOA::range_pkts_err

protected

Counter of lost ranging packets.

Referenced by command(), and recvSyncClMsg().

◆ range_pkts_recv

int UwRangingTDOA::range_pkts_recv

protected

Counter of received ranging packets.

Referenced by command(), and recvSyncClMsg().

◆ range_pkts_sent

int UwRangingTDOA::range_pkts_sent

protected

Counter of sent ranging packets.

Referenced by command(), and updateHoldoverTime().

◆ saved_entries

int UwRangingTDOA::saved_entries

protected

Total number of entries not sent in the ranging packets.

Referenced by command(), and rangeTX().

◆ scheduler_active

bool UwRangingTDOA::scheduler_active

protected

True if the ranging scheduler is been activated with Tcl "start" command.

Referenced by start(), stop(), and throttleTX().

◆ send_timer

UwRangeTimer UwRangingTDOA::send_timer

protected

Timer that schedules ranging packet transmissions.

Referenced by start(), stop(), and throttleTX().

◆ soundspeed

double UwRangingTDOA::soundspeed

protected

Speed of sound in m/s

Referenced by UwRangingTDOA().

◆ time_of_flights

std::vector<double> UwRangingTDOA::time_of_flights

protected

Referenced by command(), rangeRX(), and UwRangingTDOA().

◆ times_mat

std::vector<std::vector<double> > UwRangingTDOA::times_mat

protected

Referenced by rangeRX(), rangeTX(), updateHoldoverTime(), and UwRangingTDOA().

◆ tof_map

std::vector<std::vector<int> > UwRangingTDOA::tof_map

protected

Referenced by command(), rangeRX(), and UwRangingTDOA().

◆ tx_timestamp

std::vector<uwrange_time_t> UwRangingTDOA::tx_timestamp

protected

Vector of the TX timestamp for each packet to be sent.

Referenced by rangeTX(), and updateHoldoverTime().

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

DESERT_Framework/DESERT/ranging/uwranging_tdoa/uwranging_tdoa.h
DESERT_Framework/DESERT/ranging/uwranging_tdoa/uwranging_tdoa.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ UwRangingTDOA()

◆ ~UwRangingTDOA()

Member Function Documentation

◆ calcOptEntries()

◆ command()

◆ entryWeight()

◆ isValid() [1/2]

◆ isValid() [2/2]

◆ rangeRX()

◆ rangeTX()

◆ recv() [1/2]

◆ recv() [2/2]

◆ recvSyncClMsg()

◆ start()

◆ stop()

◆ throttleTX()

◆ updateHoldoverTime()

Friends And Related Symbol Documentation

◆ UwRangeTimer

Member Data Documentation

◆ ber

◆ debug_tdoa

◆ delay_start

◆ dist_num

◆ entries_mat

◆ entries_timestamps

◆ entry_last_tx

◆ full_pkt_tx_dur

◆ last_ids

◆ mac2phy_delay

◆ max_age

◆ max_tt

◆ n_nodes

◆ node_id

◆ packet_id

◆ phy_id

◆ PKTIDMAX

◆ poisson_traffic

◆ queue_size

◆ range_bytes_sent

◆ range_entries

◆ range_period

◆ range_pkts_err

◆ range_pkts_recv

◆ range_pkts_sent

◆ saved_entries

◆ scheduler_active

◆ send_timer

◆ soundspeed

◆ time_of_flights

◆ times_mat

◆ tof_map

◆ tx_timestamp