satellite-orbiter-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: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_ORBITER_MAC_H
#define SATELLITE_ORBITER_MAC_H
 
#include "satellite-beam-scheduler.h"
#include "satellite-fwd-link-scheduler.h"
#include "satellite-mac.h"
#include "satellite-orbiter-user-llc.h"
#include "satellite-phy.h"
#include "satellite-signal-parameters.h"
 
#include "ns3/address.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"
 
#include <stdint.h>
 
namespace ns3
{

class SatOrbiterMac : public SatMac
{
  public:
    SatOrbiterMac(void);

    SatOrbiterMac(uint32_t satId, uint32_t beamId);

    virtual ~SatOrbiterMac();

    static TypeId GetTypeId(void);
    virtual void DoInitialize(void);

    virtual void DoDispose(void);

    void StartPeriodicTransmissions();

    virtual void EnquePacket(Ptr<Packet> packet) = 0;

    void SetFwdScheduler(Ptr<SatFwdLinkScheduler> fwdScheduler);

    void SetLlc(Ptr<SatOrbiterLlc> llc);
 
    virtual Time GetGuardTime() const;
    virtual void SetGuardTime(Time guardTime);
 
    typedef Callback<void, Ptr<SatSignalParameters>> TransmitCallback;
 
    void SetTransmitCallback(SatOrbiterMac::TransmitCallback cb);
 
    typedef Callback<void, SatPhy::PacketContainer_t, Ptr<SatSignalParameters>>
        ReceiveNetDeviceCallback;
 
    void SetReceiveNetDeviceCallback(SatOrbiterMac::ReceiveNetDeviceCallback cb);

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

    void SetBeamSchedulerCallback(SatOrbiterMac::BeamSchedulerCallback cb);

    virtual void StopPeriodicTransmissions();

    virtual bool AddPeer(Mac48Address address) = 0;

    virtual bool RemovePeer(Mac48Address address) = 0;
 
  protected:
    void StartTransmission(uint32_t carrierId);

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

    virtual void RxTraces(SatPhy::PacketContainer_t packets);

    virtual SatEnums::SatLinkDir_t GetSatLinkTxDir() = 0;

    virtual SatEnums::SatLinkDir_t GetSatLinkRxDir() = 0;

    virtual Address GetRxUtAddress(Ptr<Packet> packet) = 0;

    virtual bool HasPeer() = 0;

    bool m_disableSchedulingIfNoDeviceConnected;

    Ptr<SatFwdLinkScheduler> m_fwdScheduler;

    Time m_guardTime;

    uint32_t m_satId;

    uint32_t m_beamId;

    Ptr<SatOrbiterLlc> m_llc;

    TracedCallback<Ptr<SatBbFrame>> m_bbFrameTxTrace;
 
    TransmitCallback m_txCallback;
    ReceiveNetDeviceCallback m_rxNetDeviceCallback;

    bool m_periodicTransmissionEnabled;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ORBITER_MAC_H */