satellite-bstp-controller.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2016 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_BSTP_CONTROLLER_H_
#define SATELLITE_BSTP_CONTROLLER_H_
 
#include "satellite-static-bstp.h"
 
#include "ns3/callback.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
 
#include <map>
#include <stdint.h>
#include <string>
 
namespace ns3
{

class SatBstpController : public Object
{
  public:
    typedef enum
    {
        BH_UNKNOWN = 0,
        BH_STATIC = 1,
        BH_DYNAMIC = 2,
    } BeamHoppingType_t;

    SatBstpController();

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatBstpController();

    void Initialize();

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    typedef Callback<void, bool> ToggleCallback;

    void AddNetDeviceCallback(uint32_t beamId,
                              uint32_t userFreqId,
                              uint32_t feederFreqId,
                              uint32_t gwId,
                              SatBstpController::ToggleCallback cb);
 
  protected:
    void DoBstpConfiguration();
 
  private:
    typedef std::map<uint32_t, ToggleCallback> CallbackContainer_t;
 
    CallbackContainer_t m_gwNdCallbacks;
    BeamHoppingType_t m_bhMode;
    std::string m_configFileName;

    Time m_superFrameDuration;

    Ptr<SatStaticBstp> m_staticBstp;
};
 
} // namespace ns3
 
#endif /* SATELLITE_BSTP_CONTROLLER_H_ */