uwranging_tdoa.h

Go to the documentation of this file.

//
// Copyright (c) 2022 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the University of Padova (SIGNET lab) nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
 
#ifndef UWRANGINGTDOA_H
#define UWRANGINGTDOA_H
 
#include "uwranging_tdoa_hdr.h"
#include <limits>
#include <module.h>
#include <vector>
 
class UwRangingTDOA;
 
class UwRangeTimer : public TimerHandler
{
public:
    UwRangeTimer(UwRangingTDOA *m)
        : TimerHandler()
    {
        module = m;
    }
 
protected:
    virtual void expire(Event *e);
    UwRangingTDOA *module;
};
 
class UwRangingTDOA : public Module
{
 
    friend class UwRangeTimer;
 
public:
    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:
    virtual bool isValid(double value) const;
 
    virtual bool isValid(const tdoa_entry &entry) const;
 
    virtual void rangeTX();
 
    /* Performs the reception of a ranging message.
     * @param Packet* Pointer to the packet received.
     */
    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();
 
    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; /*< Map between couples of nodes to a distance. */
    std::vector<std::vector<std::vector<tdoa_entry>>>
            entries_mat; /*< Matrix containing the entries for each packet. */
    std::vector<std::vector<double>>
            times_mat; /*< Matrix containing the tx/rx times of each packet. */
    std::vector<int> last_ids; /*< Vector of ids of the last rx/tx packet. */
    std::vector<double>
            time_of_flights; /*< Vector of one way travel times between each
                                nodes in the network. */
    std::vector<double>
            entries_timestamps; /*< Vector of the times at which each one way
                                   travel time is computed. */
    std::vector<double> entry_last_tx; 
    std::vector<uwrange_time_t> tx_timestamp; 
    std::vector<double>
            ber; /*< Vector fo the BER of each channel (symmetry assumption). */
 
    const size_t PKTIDMAX = std::numeric_limits<uwrange_pkt_t>::
            max(); 
};
 
#endif