lr-wpan-helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 The Boeing Company
 *
 * 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
 *
 * Authors:
 *  Gary Pei <guangyu.pei@boeing.com>
 *  Tom Henderson <thomas.r.henderson@boeing.com>
 */
#ifndef LR_WPAN_HELPER_H
#define LR_WPAN_HELPER_H
 
#include <ns3/lr-wpan-mac.h>
#include <ns3/lr-wpan-phy.h>
#include <ns3/node-container.h>
#include <ns3/trace-helper.h>
 
namespace ns3
{
 
class SpectrumChannel;
class MobilityModel;
 
class LrWpanHelper : public PcapHelperForDevice, public AsciiTraceHelperForDevice
{
  public:
    LrWpanHelper();
 
    LrWpanHelper(bool useMultiModelSpectrumChannel);
 
    ~LrWpanHelper() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    LrWpanHelper(const LrWpanHelper&) = delete;
    LrWpanHelper& operator=(const LrWpanHelper&) = delete;
 
    Ptr<SpectrumChannel> GetChannel();
 
    void SetChannel(Ptr<SpectrumChannel> channel);
 
    void SetChannel(std::string channelName);
 
    void AddMobility(Ptr<LrWpanPhy> phy, Ptr<MobilityModel> m);
 
    NetDeviceContainer Install(NodeContainer c);
 
    void CreateAssociatedPan(NetDeviceContainer c, uint16_t panId);
 
    void SetExtendedAddresses(NetDeviceContainer c);
 
    void EnableLogComponents();
 
    static std::string LrWpanPhyEnumerationPrinter(LrWpanPhyEnumeration e);
 
    static std::string LrWpanMacStatePrinter(LrWpanMacState e);
 
    int64_t AssignStreams(NetDeviceContainer c, int64_t stream);
 
  private:
    void EnablePcapInternal(std::string prefix,
                            Ptr<NetDevice> nd,
                            bool promiscuous,
                            bool explicitFilename) override;
 
    void EnableAsciiInternal(Ptr<OutputStreamWrapper> stream,
                             std::string prefix,
                             Ptr<NetDevice> nd,
                             bool explicitFilename) override;
 
  private:
    Ptr<SpectrumChannel> m_channel; 
};
 
} // namespace ns3
 
#endif /* LR_WPAN_HELPER_H */