satellite-conf.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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SAT_CONF_H
#define SAT_CONF_H
 
#include "ns3/geo-coordinate.h"
#include "ns3/object.h"
#include "ns3/satellite-channel.h"
#include "ns3/satellite-fwd-carrier-conf.h"
#include "ns3/satellite-superframe-sequence.h"
#include "ns3/uinteger.h"
 
#include <fstream>
#include <set>
#include <stdint.h>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatConf : public Object
{
  public:
    SatConf();
 
    virtual ~SatConf()
    {
    }

    static TypeId GetTypeId(void);
 
    inline Ptr<SatSuperframeSeq> GetSuperframeSeq()
    {
        return m_superframeSeq;
    }

    void Initialize(std::string rtnConf,
                    std::string fwdConf,
                    std::string gwPos,
                    std::string satPos,
                    std::string utPos,
                    std::string wfConf,
                    bool isConstellation = false);

    std::ifstream* OpenFile(std::string filePathName) const;

    std::vector<std::vector<uint32_t>> LoadSatConf(std::string filePathName) const;

    void SetUtPositionsPath(std::string inputFileUtListPositions);

    uint32_t GetBeamCount() const;

    std::vector<uint32_t> GetBeamConfiguration(uint32_t beamId, SatEnums::SatLinkDir_t dir) const;

    uint32_t GetRtnLinkCarrierCount() const;

    uint32_t GetGwCount() const;

    uint32_t GetUtCount() const;

    uint32_t GetSatCount() const;

    GeoCoordinate GetGwPosition(uint32_t gwId) const;

    GeoCoordinate GetUtPosition(uint32_t utId) const;

    GeoCoordinate GetSatPosition() const;

    std::string GetStartTimeStr() const;

    double GetCarrierFrequencyHz(SatEnums::ChannelType_t chType,
                                 uint32_t freqId,
                                 uint32_t carrierId);

    double GetCarrierBandwidthHz(SatEnums::ChannelType_t chType,
                                 uint32_t carrierId,
                                 SatEnums::CarrierBandwidthType_t bandwidthType);

    uint32_t GetFwdLinkCarrierCount() const;

    std::vector<std::string> LoadTles(std::string filePathName, std::string startDatePathName);

    std::vector<std::pair<uint32_t, uint32_t>> LoadIsls(std::string filePathName);

    static const uint32_t BEAM_ID_INDEX = 0;

    static const uint32_t U_FREQ_ID_INDEX = 1;

    static const uint32_t GW_ID_INDEX = 2;

    static const uint32_t F_FREQ_ID_INDEX = 3;
    static const uint32_t BEAM_ELEM_COUNT = 4;
 
  private:
    typedef std::vector<GeoCoordinate> PositionContainer_t;
 
    /*
     *  Columns:
     *  1. Beam id
     *  2. User frequency id
     *  3. GW id
     *  4. Feeder frequency id
     */
    std::vector<std::vector<uint32_t>> m_rtnConf;
    std::vector<std::vector<uint32_t>> m_fwdConf;

    bool m_isConstellation;

    uint32_t m_beamCount;

    PositionContainer_t m_gwPositions;

    PositionContainer_t m_utPositions;

    PositionContainer_t m_satPosition;

    std::vector<std::string> m_tles;

    std::string m_startTimeStr;

    Ptr<SatSuperframeSeq> m_superframeSeq;

    std::vector<Ptr<SatFwdCarrierConf>> m_forwardLinkCarrierConf;

    std::vector<Ptr<SatFwdCarrierConf>> m_returnLinkCarrierConf;

    double m_fwdFeederLinkFreqHz;

    double m_fwdFeederLinkBandwidthHz;

    double m_fwdUserLinkFreqHz;

    double m_fwdUserLinkBandwidthHz;

    double m_rtnFeederLinkFreqHz;

    double m_rtnFeederLinkBandwidthHz;

    double m_rtnUserLinkFreqHz;

    double m_rtnUserLinkBandwidthHz;

    uint32_t m_fwdUserLinkChannelCount;
    uint32_t m_rtnUserLinkChannelCount;
    uint32_t m_fwdFeederLinkChannelCount;
    uint32_t m_rtnFeederLinkChannelCount;

    SatSuperframeConf::SuperFrameConfiguration_t m_SuperFrameConfForSeq0;

    double m_fwdCarrierAllocatedBandwidthHz;

    double m_fwdCarrierRollOffFactor;

    double m_fwdCarrierSpacingFactor;

    double m_rtnCarrierAllocatedBandwidthHz;

    double m_rtnCarrierRollOffFactor;

    double m_rtnCarrierSpacingFactor;

    SatEnums::RegenerationMode_t m_forwardLinkRegenerationMode;

    SatEnums::RegenerationMode_t m_returnLinkRegenerationMode;

    double GetFwdLinkCarrierBandwidthHz(uint32_t carrierId,
                                        SatEnums::CarrierBandwidthType_t bandwidthType) const;

    double GetRtnLinkCarrierBandwidthHz(uint32_t carrierId,
                                        SatEnums::CarrierBandwidthType_t bandwidthType) const;

    void Configure(std::string wfConf);

    uint32_t GetSuperframeCarrierId(uint32_t carrierId, uint32_t* seqId);

    uint32_t GetGlobalCarrierId(uint32_t seqId, uint32_t carrierId);

    void LoadPositions(std::string filePathName, PositionContainer_t& container);
};
 
} // namespace ns3
 
#endif /* SAT_CONF_H */