satellite-antenna-gain-pattern-container.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_CONTAINER_H_
#define SATELLITE_ANTENNA_GAIN_PATTERN_CONTAINER_H_
 
#include "geo-coordinate.h"
#include "satellite-antenna-gain-pattern.h"
 
#include "ns3/satellite-beam-user-info.h"
 
#include <map>
#include <stdint.h>
#include <string>
#include <utility>
 
namespace ns3
{
 
class SatMobilityModel;

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

    SatAntennaGainPatternContainer();

    SatAntennaGainPatternContainer(uint32_t nbSats, std::string patternsFolder);
    ~SatAntennaGainPatternContainer();

    typedef std::map<std::pair<uint32_t, uint32_t>, SatBeamUserInfo> BeamUserInfoMap_t;

    GeoCoordinate GetDefaultGeoPosition();

    Ptr<SatAntennaGainPattern> GetAntennaGainPattern(uint32_t beamId) const;

    Ptr<SatMobilityModel> GetAntennaMobility(uint32_t satelliteId) const;

    uint32_t GetNAntennaGainPatterns() const;

    uint32_t GetBestBeamId(uint32_t satelliteId, GeoCoordinate coord, bool ignoreNan);

    double GetBeamGain(uint32_t satelliteId, uint32_t beamId, GeoCoordinate coord);
 
    void ConfigureBeamsMobility(uint32_t satelliteId, Ptr<SatMobilityModel> mobility);
 
    void SetEnabledBeams(BeamUserInfoMap_t& info);
 
  private:
    std::string m_patternsFolder;

    std::map<uint32_t, Ptr<SatAntennaGainPattern>> m_antennaPatternMap;

    std::map<uint32_t, Ptr<SatMobilityModel>> m_mobilityModelMap;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ANTENNA_GAIN_PATTERN_CONTAINER_H_ */