satellite-handover-module.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2018 CNES
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.fr>
 */
 
#ifndef SATELLITE_HANDOVER_MODULE_H
#define SATELLITE_HANDOVER_MODULE_H
 
#include "satellite-antenna-gain-pattern-container.h"
 
#include "ns3/callback.h"
#include "ns3/node-container.h"
#include "ns3/node.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
 
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatHandoverModule : public Object
{
  public:
    typedef enum
    {
        SAT_N_CLOSEST_SAT,
    } HandoverDecisionAlgorithm_t;

    typedef Callback<void, uint32_t, uint32_t> HandoverRequestCallback;

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    SatHandoverModule();

    SatHandoverModule(Ptr<Node> utNode,
                      NodeContainer satellites,
                      Ptr<SatAntennaGainPatternContainer> agpContainer);

    ~SatHandoverModule();

    void SetHandoverRequestCallback(SatHandoverModule::HandoverRequestCallback cb);

    uint32_t GetAskedSatId();

    uint32_t GetAskedBeamId();

    void HandoverFinished();

    bool CheckForHandoverRecommendation(uint32_t satId, uint32_t beamId);
 
  private:
    std::vector<uint32_t> GetNClosestSats(uint32_t numberOfSats);

    std::pair<uint32_t, uint32_t> AlgorithmNClosest(GeoCoordinate coords);

    HandoverDecisionAlgorithm_t m_handoverDecisionAlgorithm;

    uint32_t m_numberClosestSats;
 
    HandoverRequestCallback m_handoverCallback;
 
    Ptr<Node> m_utNode;
    NodeContainer m_satellites;
    Ptr<SatAntennaGainPatternContainer> m_antennaGainPatterns;
 
    Time m_lastMessageSentAt;
    Time m_repeatRequestTimeout;
    bool m_hasPendingRequest;
    uint32_t m_askedSatId;
    uint32_t m_askedBeamId;
 
    TracedCallback<double> m_antennaGainTrace;
};
 
} // namespace ns3
 
#endif /* SATELLITE_HANDOVER_MODULE_H */