satellite-fading-external-input-trace-container.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 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 SATELLITE_FADING_EXTERNAL_INPUT_TRACE_CONTAINER_H_
#define SATELLITE_FADING_EXTERNAL_INPUT_TRACE_CONTAINER_H_
 
#include "geo-coordinate.h"
#include "satellite-enums.h"
#include "satellite-fading-external-input-trace.h"
 
#include "ns3/mobility-model.h"
#include "ns3/object.h"
 
#include <map>
#include <stdint.h>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatFadingExternalInputTraceContainer : public Object
{
  public:
    typedef enum
    {
        LIST_MODE,     
        POSITION_MODE, 
        RANDOM_MODE    
    } InputMode_t;

    typedef std::pair<Ptr<SatFadingExternalInputTrace>, Ptr<SatFadingExternalInputTrace>>
        ChannelTracePair_t;

    static TypeId GetTypeId(void);

    SatFadingExternalInputTraceContainer();

    virtual void NotifyConstructionCompleted() override;

    ~SatFadingExternalInputTraceContainer();

    Ptr<SatFadingExternalInputTrace> GetFadingTrace(uint32_t nodeId,
                                                    SatEnums::ChannelType_t channelType,
                                                    Ptr<MobilityModel> mobility);

    bool TestFadingTraces(uint32_t numOfUts, uint32_t numOfGws);
 
  private:
    typedef std::pair<std::string, GeoCoordinate> TraceFileContainerItem_t;
    typedef std::vector<TraceFileContainerItem_t> TraceFileContainer_t;
 
    typedef std::map<std::string, Ptr<SatFadingExternalInputTrace>> TraceInputContainer_t;

    std::map<uint32_t, ChannelTracePair_t> m_utFadingMap;

    std::map<uint32_t, ChannelTracePair_t> m_gwFadingMap;

    InputMode_t m_utInputMode;

    std::string m_utFwdDownIndexFileName;

    std::string m_utRtnUpIndexFileName;

    std::string m_gwFwdUpIndexFileName;

    std::string m_gwRtnDownIndexFileName;

    TraceFileContainer_t m_utFwdDownFileNames;

    TraceFileContainer_t m_utRtnUpFileNames;

    TraceFileContainer_t m_gwFwdUpFileNames;

    TraceFileContainer_t m_gwRtnDownFileNames;

    TraceInputContainer_t m_loadedTraces;

    bool m_indexFilesLoaded;

    std::string m_dataPath;

    double m_maxDistanceToFading;

    void LoadIndexFiles();

    void CreateUtFadingTrace(uint32_t utId, Ptr<MobilityModel> mobility);

    void CreateGwFadingTrace(uint32_t gwId, Ptr<MobilityModel> mobility);

    void ReadIndexFile(std::string indexFile, TraceFileContainer_t& container);

    Ptr<SatFadingExternalInputTrace> CreateFadingTrace(
        SatFadingExternalInputTrace::TraceFileType_e fileType,
        InputMode_t inputMode,
        TraceFileContainer_t& container,
        uint32_t id,
        Ptr<MobilityModel> mobility);
    std::string FindSourceBasedOnPosition(TraceFileContainer_t& container,
                                          uint32_t id,
                                          Ptr<MobilityModel> mobility);
};
 
} // namespace ns3
 
#endif /* SATELLITE_FADING_EXTERNAL_INPUT_TRACE_CONTAINER_H_ */