mesh-helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008,2009 IITP RAS
 *
 * 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: Kirill Andreev <andreev@iitp.ru>
 *         Pavel Boyko <boyko@iitp.ru>
 */
 
#ifndef MESH_HELPER_H
#define MESH_HELPER_H
 
#include "mesh-stack-installer.h"
 
#include "ns3/object-factory.h"
#include "ns3/qos-utils.h"
#include "ns3/wifi-standards.h"
 
namespace ns3
{
 
class NetDeviceContainer;
class WifiPhyHelper;
class WifiNetDevice;
class NodeContainer;
 
class MeshHelper
{
  public:
    MeshHelper();
 
    ~MeshHelper();
 
    static MeshHelper Default();
 
    template <typename... Ts>
    void SetMacType(Ts&&... args);
    template <typename... Ts>
    void SetRemoteStationManager(std::string type, Ts&&... args);
    void SetStandard(WifiStandard standard);
 
    // void SetMeshId (std::string s);
    enum ChannelPolicy
    {
        SPREAD_CHANNELS,
        ZERO_CHANNEL
    };
 
    void SetSpreadInterfaceChannels(ChannelPolicy policy);
    void SetNumberOfInterfaces(uint32_t nInterfaces);
 
    NetDeviceContainer Install(const WifiPhyHelper& phyHelper, NodeContainer c) const;
    template <typename... Ts>
    void SetStackInstaller(std::string type, Ts&&... args);
 
    void Report(const ns3::Ptr<ns3::NetDevice>& device, std::ostream& os);
 
    void ResetStats(const ns3::Ptr<ns3::NetDevice>& device);
    int64_t AssignStreams(NetDeviceContainer c, int64_t stream);
 
    static void EnableLogComponents();
 
  private:
    Ptr<WifiNetDevice> CreateInterface(const WifiPhyHelper& phyHelper,
                                       Ptr<Node> node,
                                       uint16_t channelId) const;
    uint32_t m_nInterfaces;              
    ChannelPolicy m_spreadChannelPolicy; 
    Ptr<MeshStack> m_stack;              
    ObjectFactory m_stackFactory;        
 
    // Interface factory
    ObjectFactory m_mac;                  
    ObjectFactory m_stationManager;       
    ObjectFactory m_ackPolicySelector[4]; 
    WifiStandard m_standard;              
};
 
/***************************************************************
 *  Implementation of the templates declared above.
 ***************************************************************/
 
template <typename... Ts>
void
MeshHelper::SetMacType(Ts&&... args)
{
    m_mac.SetTypeId("ns3::MeshWifiInterfaceMac");
    m_mac.Set(std::forward<Ts>(args)...);
}
 
template <typename... Ts>
void
MeshHelper::SetRemoteStationManager(std::string type, Ts&&... args)
{
    m_stationManager = ObjectFactory(type, std::forward<Ts>(args)...);
}
 
template <typename... Ts>
void
MeshHelper::SetStackInstaller(std::string type, Ts&&... args)
{
    m_stackFactory.SetTypeId(type);
    m_stackFactory.Set(std::forward<Ts>(args)...);
    m_stack = m_stackFactory.Create<MeshStack>();
    if (!m_stack)
    {
        NS_FATAL_ERROR("Stack has not been created: " << type);
    }
}
 
} // namespace ns3
 
#endif /* MESH_HELPER_H */