satellite-beam-channel-pair.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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: Mathias Ettinger <mettinger@toulouse.viveris.com>
 */
 
#ifndef SATELLITE_BEAM_CHANNEL_PAIR_H
#define SATELLITE_BEAM_CHANNEL_PAIR_H
 
#include "satellite-channel.h"
#include "satellite-typedefs.h"
 
#include "ns3/object.h"
 
#include <map>
#include <stdint.h>
#include <utility>
 
namespace ns3
{

 
class SatChannelPair : public Object
{
  public:
    typedef std::pair<Ptr<SatChannel>, Ptr<SatChannel>>
        ChannelPair_t; // forward = first, return  = second

    SatChannelPair();

    virtual ~SatChannelPair();

    static TypeId GetTypeId(void);

    ChannelPair_t GetChannelPair(uint32_t satId, uint32_t beamId) const;
    Ptr<SatChannel> GetForwardChannel(uint32_t satId, uint32_t frequencyId) const;
    Ptr<SatChannel> GetReturnChannel(uint32_t satId, uint32_t frequencyId) const;

    // bool HasChannelPair (uint32_t frequencyId);
    bool HasFwdChannel(uint32_t satId, uint32_t frequencyId) const;
    bool HasRtnChannel(uint32_t satId, uint32_t frequencyId) const;

    // void UpdateBeamsForFrequency (uint32_t beamdId, uint32_t frequencyId);
    void UpdateBeamsForFrequency(uint32_t satId,
                                 uint32_t beamdId,
                                 uint32_t fwdFrequencyId,
                                 uint32_t rtnFrequencyId);

    // void StoreChannelPair (uint32_t beamId, uint32_t frequencyId, ChannelPair_t channels);
    void StoreChannelPair(uint32_t satId,
                          uint32_t beamId,
                          uint32_t fwdFrequencyId,
                          Ptr<SatChannel> fwdChannel,
                          uint32_t rtnFrequencyId,
                          Ptr<SatChannel> rtnChannel);
 
  private:
    std::map<std::pair<uint32_t, uint32_t>, std::pair<uint32_t, uint32_t>>
        m_frequencies; // map from beam ID to frequency ID
    std::map<std::pair<uint32_t, uint32_t>, Ptr<SatChannel>> m_fwdChannels;
    std::map<std::pair<uint32_t, uint32_t>, Ptr<SatChannel>> m_rtnChannels;
};
 
} // namespace ns3
 
#endif /* SATELLITE_BEAM_CHANNEL_PAIR_H */