satellite-mac.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 *
 * 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: Sami Rantanen <sami.rantanen@magister.fi>
 */
 
#ifndef SAT_MAC_H
#define SAT_MAC_H
 
#include "satellite-control-message.h"
#include "satellite-handover-module.h"
#include "satellite-node-info.h"
#include "satellite-phy.h"
#include "satellite-queue.h"
#include "satellite-signal-parameters.h"
 
#include "ns3/address.h"
#include "ns3/callback.h"
#include "ns3/mac48-address.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
 
#include <cstring>
#include <queue>
#include <stdint.h>
#include <string>
 
namespace ns3
{
 
class Packet;
class SatBeamScheduler;

class SatMac : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatMac();

    SatMac(uint32_t satId, uint32_t beamId);

    ~SatMac();

    inline uint32_t GetSatId() const
    {
        return m_satId;
    }

    inline uint32_t GetBeamId() const
    {
        return m_beamId;
    }

    inline void SetSatId(uint32_t satId)
    {
        m_satId = satId;
    }

    inline void SetBeamId(uint32_t beamId)
    {
        m_beamId = beamId;
    }

    inline Address GetAddress() const
    {
        return m_nodeInfo->GetMacAddress();
    }

    void SetHandoverModule(Ptr<SatHandoverModule> handoverModule);

    typedef Callback<void, SatPhy::PacketContainer_t, uint32_t, Time, SatSignalParameters::txInfo_s>
        TransmitCallback;

    void SetTransmitCallback(SatMac::TransmitCallback cb);

    typedef Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> ReceiveCallback;

    typedef Callback<void, Ptr<const Packet>> LoraReceiveCallback;

    void SetReceiveCallback(SatMac::ReceiveCallback cb);

    void SetLoraReceiveCallback(SatMac::LoraReceiveCallback cb);

    typedef Callback<Ptr<SatControlMessage>, uint32_t> ReadCtrlMsgCallback;

    typedef Callback<uint32_t, Ptr<SatControlMessage>> ReserveCtrlMsgCallback;

    typedef Callback<uint32_t, uint32_t> SendCtrlMsgCallback;

    typedef Callback<Ptr<SatBeamScheduler>, uint32_t, uint32_t> BeamSchedulerCallback;

    typedef Callback<void> UpdateIslCallback;

    void SetReadCtrlCallback(SatMac::ReadCtrlMsgCallback cb);

    void SetReserveCtrlCallback(SatMac::ReserveCtrlMsgCallback cb);

    void SetSendCtrlCallback(SatMac::SendCtrlMsgCallback cb);

    void SetBeamSchedulerCallback(SatMac::BeamSchedulerCallback cb);

    void SetUpdateIslCallback(SatMac::UpdateIslCallback cb);

    typedef Callback<void, Address, Address> RoutingUpdateCallback;

    void SetRoutingUpdateCallback(SatMac::RoutingUpdateCallback cb);

    virtual void SetNodeInfo(Ptr<SatNodeInfo> nodeInfo);

    uint32_t ReserveIdAndStoreCtrlMsgToContainer(Ptr<SatControlMessage> msg);

    uint32_t SendCtrlMsgFromContainer(uint32_t sendId);

    virtual void ReceiveQueueEvent(SatQueue::QueueEvent_t event, uint8_t flowIndex);

    virtual void Enable();

    virtual void Disable();

    virtual void SetSatelliteAddress(Address satelliteAddress);
 
  private:
    SatMac& operator=(const SatMac&);
    SatMac(const SatMac&);
 
  protected:
    void DoDispose(void);

    void SetTimeTag(SatPhy::PacketContainer_t packets);

    virtual void SendPacket(SatPhy::PacketContainer_t packets,
                            uint32_t carrierId,
                            Time duration,
                            SatSignalParameters::txInfo_s txInfo);

    void RxTraces(SatPhy::PacketContainer_t packets);

    SatMac::TransmitCallback m_txCallback;

    SatMac::ReceiveCallback m_rxCallback;

    SatMac::LoraReceiveCallback m_rxLoraCallback;

    SatMac::ReadCtrlMsgCallback m_readCtrlCallback;

    SatMac::ReserveCtrlMsgCallback m_reserveCtrlCallback;

    SatMac::SendCtrlMsgCallback m_sendCtrlCallback;

    SatMac::BeamSchedulerCallback m_beamSchedulerCallback;

    SatMac::UpdateIslCallback m_updateIslCallback;

    bool m_isStatisticsTagsEnabled;

    bool m_ncrV2;

    TracedCallback<Time,
                   SatEnums::SatPacketEvent_t,
                   SatEnums::SatNodeType_t,
                   uint32_t,
                   Mac48Address,
                   SatEnums::SatLogLevel_t,
                   SatEnums::SatLinkDir_t,
                   std::string>
        m_packetTrace;

    TracedCallback<Ptr<const Packet>, const Address&> m_rxTrace;

    TracedCallback<const Time&, const Address&> m_rxDelayTrace;

    TracedCallback<const Time&, const Address&> m_rxLinkDelayTrace;

    TracedCallback<const Time&, const Address&> m_rxJitterTrace;

    TracedCallback<const Time&, const Address&> m_rxLinkJitterTrace;

    TracedCallback<Time> m_beamServiceTrace;

    SatMac::RoutingUpdateCallback m_routingUpdateCallback;

    Ptr<SatNodeInfo> m_nodeInfo;

    uint32_t m_satId;

    uint32_t m_beamId;

    Ptr<SatHandoverModule> m_handoverModule;

    bool m_txEnabled;

    Time m_beamEnabledTime;

    Time m_lastDelay;

    std::queue<Ptr<SatNcrMessage>> m_ncrMessagesToSend;

    std::queue<Time> m_lastSOF;

    SatEnums::RegenerationMode_t m_forwardLinkRegenerationMode;

    SatEnums::RegenerationMode_t m_returnLinkRegenerationMode;

    bool m_isRegenerative;

    Address m_satelliteAddress;

    Time m_lastLinkDelay;
};
 
} // namespace ns3
 
#endif /* SAT_MAC_H */