satellite-position-allocator.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: Sami Rantanen <sami.rantanen@magister.fi>
 * Author: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_POSITION_ALLOCATOR_H
#define SATELLITE_POSITION_ALLOCATOR_H
 
#include "geo-coordinate.h"
#include "satellite-antenna-gain-pattern-container.h"
 
#include "ns3/object.h"
#include "ns3/position-allocator.h"
#include "ns3/random-variable-stream.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatPositionAllocator : public PositionAllocator
{
  public:
    static TypeId GetTypeId(void);

    SatPositionAllocator();

    virtual ~SatPositionAllocator();

    virtual GeoCoordinate GetNextGeoPosition(uint32_t satId = 0) const = 0;
 
    virtual Vector GetNext(void) const;
    virtual int64_t AssignStreams(int64_t stream);
 
  private:
    /*
     * This is the flag for indicating that when calling method GetNext (defined by class
     * PositionAlocator) is returned Vector filled by longitude (in x), latitude (in y) and altitude
     * (in z) this enables using ns-3 mobility helper without to convert geo coordinates first to
     * Cartesian but if for some reason used model needs Cartesian coordinates then this flag can be
     * turned off through attribute 'AsGeoCoordinates'.
     */
    bool m_GetAsGeoCoordinates;
};

class SatListPositionAllocator : public SatPositionAllocator
{
  public:
    static TypeId GetTypeId(void);

    SatListPositionAllocator();

    void Add(GeoCoordinate coordinate);

    virtual GeoCoordinate GetNextGeoPosition(uint32_t satId = 0) const;
 
    inline virtual void SetToBegin()
    {
        m_current = m_positions.begin();
    }
 
    inline virtual uint32_t GetCount()
    {
        return m_positions.size();
    }
 
  private:
    std::vector<GeoCoordinate> m_positions;
    mutable std::vector<GeoCoordinate>::const_iterator m_current;
};

class SatRandomBoxPositionAllocator : public SatPositionAllocator
{
  public:
    static TypeId GetTypeId(void);

    SatRandomBoxPositionAllocator();

    virtual ~SatRandomBoxPositionAllocator();
 
    void SetLatitude(Ptr<RandomVariableStream> latitude);
    void SetLongitude(Ptr<RandomVariableStream> longitude);
    void SetAltitude(Ptr<RandomVariableStream> altitude);

    virtual GeoCoordinate GetNextGeoPosition(uint32_t satId = 0) const;
    virtual int64_t AssignStreams(int64_t stream);
 
  private:
    Ptr<RandomVariableStream> m_latitude;
    Ptr<RandomVariableStream> m_longitude;
    Ptr<RandomVariableStream> m_altitude;
};

class SatRandomCirclePositionAllocator : public SatPositionAllocator
{
  public:
    static TypeId GetTypeId(void);

    SatRandomCirclePositionAllocator();

    SatRandomCirclePositionAllocator(GeoCoordinate center, uint32_t radius);

    virtual ~SatRandomCirclePositionAllocator();
 
    void SetCenter(GeoCoordinate center);
    void SetRadius(uint32_t radius);

    virtual GeoCoordinate GetNextGeoPosition(uint32_t satId = 0) const;
    virtual int64_t AssignStreams(int64_t stream);
 
  private:
    GeoCoordinate m_center;
    uint32_t m_radius;
    Ptr<RandomVariableStream> m_rand;
};

class SatSpotBeamPositionAllocator : public SatPositionAllocator
{
  public:
    static TypeId GetTypeId(void);

    SatSpotBeamPositionAllocator();

    SatSpotBeamPositionAllocator(uint32_t beamId,
                                 Ptr<SatAntennaGainPatternContainer> patternContainer,
                                 GeoCoordinate geoPos);

    virtual ~SatSpotBeamPositionAllocator();
 
    void SetAltitude(Ptr<RandomVariableStream> altitude);

    virtual GeoCoordinate GetNextGeoPosition(uint32_t satId) const;
    virtual int64_t AssignStreams(int64_t stream);
 
  private:
    static constexpr uint32_t MAX_TRIES = 100;

    static constexpr double MIN_ANTENNA_GAIN = 40.0;

    uint32_t m_targetBeamId;

    double m_minElevationAngleInDeg;

    Ptr<SatAntennaGainPatternContainer> m_antennaGainPatterns;

    GeoCoordinate m_geoPos;

    Ptr<RandomVariableStream> m_altitude;
};
 
} // namespace ns3
 
#endif /* POSITION_ALLOCATOR_H */