satellite-antenna-gain-pattern.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 SATELLITE_ANTENNA_GAIN_PATTERN_H
#define SATELLITE_ANTENNA_GAIN_PATTERN_H
 
#include "geo-coordinate.h"
#include "satellite-mobility-model.h"
 
#include "ns3/object.h"
#include "ns3/random-variable-stream.h"
#include "ns3/traced-callback.h"
 
#include <fstream>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatAntennaGainPattern : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatAntennaGainPattern();

    SatAntennaGainPattern(std::string filePathName, GeoCoordinate defaultSatellitePosition);

    virtual void NotifyConstructionCompleted() override;
 
    ~SatAntennaGainPattern()
    {
    }

    double GetAntennaGain_lin(GeoCoordinate coord, Ptr<SatMobilityModel> mobility) const;

    GeoCoordinate GetValidRandomPosition(Ptr<SatMobilityModel> mobility) const;

    bool IsValidPosition(GeoCoordinate coord,
                         TracedCallback<double> cb,
                         Ptr<SatMobilityModel> mobility) const;
 
    void GetSatelliteOffset(double& latOffset,
                            double& lonOffset,
                            Ptr<SatMobilityModel> mobility) const;

    double GetCenterLatitude(Ptr<SatMobilityModel> mobility) const;

    double GetCenterLongitude(Ptr<SatMobilityModel> mobility) const;
 
  private:
    void ReadAntennaPatternFromFile(std::string filePathName);

    std::vector<std::vector<double>> m_antennaPattern;

    std::vector<std::pair<double, double>> m_validPositions;

    double m_minAcceptableAntennaGainInDb;

    Ptr<UniformRandomVariable> m_uniformRandomVariable;

    std::vector<double> m_latitudes;

    std::vector<double> m_longitudes;

    double m_centerLatitude;

    double m_centerLongitude;

    double m_minLat;

    double m_minLon;

    double m_maxLat;

    double m_maxLon;

    double m_latInterval;

    double m_lonInterval;

    double m_latDefaultSatellite;

    double m_lonDefaultSatellite;

    static const std::string m_nanStringArray[4];
    std::vector<std::string> m_nanStrings;
 
    std::string m_filePathName;
    GeoCoordinate m_defaultSatellitePosition;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ANTENNA_GAIN_PATTERN_H */