satellite-uplink-info-tag.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: Author: Bastien TAURAN <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_UPLINK_INFO_TAG_H
#define SATELLITE_UPLINK_INFO_TAG_H
 
#include "ns3/nstime.h"
#include "ns3/tag.h"
 
#include <ostream>
#include <stdint.h>
 
namespace ns3
{

class SatUplinkInfoTag : public Tag
{
  public:
    static TypeId GetTypeId(void);

    virtual TypeId GetInstanceTypeId(void) const;

    SatUplinkInfoTag();

    SatUplinkInfoTag(Time satelliteReceptionTime,
                     double sinr,
                     double additionalInterference,
                     uint32_t satId,
                     uint32_t beamId,
                     bool isControl);

    virtual void Serialize(TagBuffer i) const;

    virtual void Deserialize(TagBuffer i);

    virtual uint32_t GetSerializedSize() const;

    virtual void Print(std::ostream& os) const;

    Time GetSatelliteReceptionTime(void) const;

    void SetSatelliteReceptionTime(Time satelliteReceptionTime);

    double GetSinr(void) const;

    void SetSinr(double sinr, double additionalInterference);

    double GetAdditionalInterference(void) const;

    bool IsSinrComputed(void) const;

    uint32_t GetSatId(void) const;

    void SetSatId(uint32_t satId);

    uint32_t GetBeamId(void) const;

    void SetBeamId(uint32_t beamId);

    bool IsControl(void) const;

    void SetIsControl(bool isControl);
 
  private:
    Time m_satelliteReceptionTime;   // Reception time of packet in satellite
    double m_sinr;                   // SINR computed on uplink
    double m_additionalInterference; // Other interference to add to compute final SINR
    bool m_sinrComputed;             // Flag to tell if SINR has been already computed
    uint32_t m_satId;                // Sat ID where the UT is located
    uint32_t m_beamId;               // Beam ID where the UT is located
    bool m_isControl;                // Uplink burst is control and has been sent using WF02
};
 
} // namespace ns3
 
#endif /* SATELLITE_UPLINK_INFO_TAG_H */