satellite-phy-tx.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 * 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: Jani Puttonen <jani.puttonen@magister.fi>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.com>
 */
 
#ifndef SATELLITE_PHY_TX_H
#define SATELLITE_PHY_TX_H
 
#include "satellite-antenna-gain-pattern.h"
#include "satellite-base-fading.h"
#include "satellite-mobility-model.h"
#include "satellite-net-device.h"
#include "satellite-signal-parameters.h"
 
#include <ns3/mac48-address.h>
#include <ns3/mobility-model.h>
#include <ns3/nstime.h>
#include <ns3/packet.h>
 
#include <map>
#include <stdint.h>
 
namespace ns3
{
 
class SatChannel;
 
class SatPhyTx : public Object
{
  public:
    typedef enum
    {
        NORMAL,
        TRANSPARENT
    } SatPhyTxMode_t;
 
    SatPhyTx();
 
    virtual ~SatPhyTx();
 
    enum State
    {
        IDLE,
        TX,
        RECONFIGURING
    };
 
    static TypeId GetTypeId(void);
 
    virtual void DoDispose();
 
    void SetChannel(Ptr<SatChannel> c);
    void ClearChannel();
    Ptr<SatChannel> GetChannel();
 
    void SetMobility(Ptr<MobilityModel> m);
    Ptr<MobilityModel> GetMobility();
 
    /*
     * Set the transmit antenna gain pattern.
     * \param agp antenna gain pattern
     * \param mobility mobility model of satellite
     */
    void SetAntennaGainPattern(Ptr<SatAntennaGainPattern> agp, Ptr<SatMobilityModel> mobility);
 
    void SetMaxAntennaGain_Db(double gain_db);
 
    double GetAntennaGain(Ptr<MobilityModel> mobility);
 
    void SetDefaultFadingValue(double fadingValue);
 
    double GetFadingValue(Address macAddress, SatEnums::ChannelType_t channelType);
 
    void SetFadingContainer(Ptr<SatBaseFading> fadingContainer);
 
    virtual void StartTx(Ptr<SatSignalParameters> txParams);
 
    void SetSatId(uint32_t satId);
 
    void SetBeamId(uint32_t beamId);
 
    bool IsTransmitting(void) const;
 
    bool CanTransmit(void) const;
 
  protected:
    virtual void EndTx();
 
  private:
    void ChangeState(State newState);
 
    Ptr<MobilityModel> m_mobility;
    Ptr<SatChannel> m_channel;
 
    /*
     * Transmit antenna gain pattern
     */
    Ptr<SatAntennaGainPattern> m_antennaGainPattern;
 
    /*
     * Satellite mobility model
     */
    Ptr<SatMobilityModel> m_satMobility;
 
    double m_maxAntennaGain;
 
    State m_state;
    uint32_t m_satId;
    uint32_t m_beamId;
    SatPhyTxMode_t m_txMode;
 
    Ptr<SatBaseFading> m_fadingContainer;
 
    double m_defaultFadingValue;
};
 
} // namespace ns3
 
#endif /* SATELLITE_PHY_TX_H */