satellite-cno-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) 2020 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_CNO_HELPER_H__
#define __SATELLITE_CNO_HELPER_H__
 
#include "satellite-helper.h"
 
#include "ns3/log.h"
#include "ns3/object.h"
#include "ns3/type-id.h"
 
#include <stdint.h>
#include <string>
#include <vector>
 
namespace ns3
{

class SatCnoHelper : public Object
{
  public:
    typedef struct
    {
        Ptr<Node> node;
        bool isGw;
        bool constant;
        SatEnums::ChannelType_t channelType;
        std::string pathToFile;
        double cno;
    } cnoCustomParams_s;

    static TypeId GetTypeId(void);

    SatCnoHelper();

    SatCnoHelper(Ptr<SatHelper> satHelper);

    virtual ~SatCnoHelper()
    {
    }

    void UseTracesForDefault(bool useTraces);

    void SetGwNodeCno(Ptr<Node> node, SatEnums::ChannelType_t channel, double cno);

    void SetUtNodeCno(Ptr<Node> node, SatEnums::ChannelType_t channel, double cno);

    void SetGwNodeCno(uint32_t nodeId, SatEnums::ChannelType_t channel, double cno);

    void SetUtNodeCno(uint32_t nodeId, SatEnums::ChannelType_t channel, double cno);

    void SetGwNodeCno(NodeContainer nodes, SatEnums::ChannelType_t channel, double cno);

    void SetUtNodeCno(NodeContainer nodes, SatEnums::ChannelType_t channel, double cno);

    void SetGwNodeCnoFile(Ptr<Node> node, SatEnums::ChannelType_t channel, std::string path);

    void SetUtNodeCnoFile(Ptr<Node> node, SatEnums::ChannelType_t channel, std::string path);

    void SetGwNodeCnoFile(uint32_t nodeId, SatEnums::ChannelType_t channel, std::string path);

    void SetUtNodeCnoFile(uint32_t nodeId, SatEnums::ChannelType_t channel, std::string path);
 
  private:
 
    Ptr<SatHelper> m_satHelper;

    bool m_useTraces;

    std::vector<cnoCustomParams_s> m_customCno;

    void ApplyConfiguration();

    bool CheckDuplicate(Ptr<Node> node, SatEnums::ChannelType_t channel);
};
 
} // namespace ns3
 
#endif /* __SATELLITE_CNO_HELPER_H__ */