satellite-group-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 * Copyright (c) 2018 CNES
 *
 * 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: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_GROUP_HELPER_H
#define SATELLITE_GROUP_HELPER_H
 
#include "ns3/geo-coordinate.h"
#include "ns3/mobility-helper.h"
#include "ns3/node-container.h"
#include "ns3/satellite-handover-module.h"
#include "ns3/satellite-mobility-model.h"
#include "ns3/satellite-position-allocator.h"
#include "ns3/vector.h"
 
#include <algorithm>
#include <list>
#include <map>
#include <set>
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{
 
class SatHelper;

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

    SatGroupHelper();

    virtual ~SatGroupHelper()
    {
    }

    void Init();

    void AddUtNodeToGroup(uint32_t groupId, Ptr<Node> node);

    void AddUtNodesToGroup(uint32_t groupId, NodeContainer nodes);

    void CreateGroupFromPosition(uint32_t groupId,
                                 NodeContainer nodes,
                                 GeoCoordinate center,
                                 uint32_t radius);

    void CreateGroupsUniformly(std::vector<uint32_t> groupIds, NodeContainer nodes);

    void CreateUtNodesFromPosition(uint32_t groupId,
                                   uint32_t nb,
                                   GeoCoordinate center,
                                   uint32_t radius);

    void AddNodeToGroupAfterScenarioCreation(uint32_t groupId, Ptr<Node> node);

    std::vector<std::pair<GeoCoordinate, uint32_t>> GetAdditionalNodesPerBeam();

    NodeContainer GetUtNodes(uint32_t groupId) const;

    uint32_t GetN();

    std::list<uint32_t> GetGroups();

    virtual void DoDispose();
 
    void SetSatConstellationEnabled();
 
  private:
    bool IsGroupExisting(uint32_t groupId) const;

    uint32_t GetGroupId(Ptr<Node> node) const;

    NodeContainer GetNodesNotAddedFromPosition(NodeContainer nodes);

    std::map<uint32_t, std::set<Ptr<Node>>> m_groupsMap;

    std::list<uint32_t> m_groupsList;

    std::vector<std::pair<GeoCoordinate, uint32_t>> m_additionalNodesPerBeam;
 
    /*
     * Map to store node to add to groups after scenario is created
     */
    std::map<Ptr<Node>, uint32_t> m_nodesToAdd;
 
    /*
     * Tells if the scenario has been created by simulation helper.
     * Some methods have to be called before, some after.
     */
    bool m_scenarioCreated;

    bool m_satConstellationEnabled;
};
 
} // namespace ns3
 
#endif /* SATELLITE_GROUP_HELPER_H */