Attachment #1277 for bug #962

View | Details | Raw Unified | Return to bug 962
Collapse All | Expand All




/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c)  2011 CTTC
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 */


#include "generic-phy.h"
#include <ns3/log.h>


NS_LOG_COMPONENT_DEFINE ("GenericPhy");

namespace ns3 {


NS_OBJECT_ENSURE_REGISTERED (GenericPhy);


GenericPhy::GenericPhy ()
{
  NS_LOG_FUNCTION (this);
}

TypeId
GenericPhy::GetTypeId (void)
{
  static TypeId tid = TypeId ("ns3::GenericPhy")
    .SetParent<Object> ()
  ;
  return tid;
}

GenericPhy::~GenericPhy ()
{
}

} // namespace ns3




/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c)  2010,2011 CTTC
 *
 * 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

#define GENERIC_PHY_H

#include <ns3/callback.h>
#include <ns3/object.h>

namespace ns3 {

class Packet;

/**
 * This method allows the MAC to instruct the PHY to start a

 */
typedef Callback< void, Ptr<Packet> > GenericPhyRxEndOkCallback;


/**
 * The GenericPhy Object is provided as a base class for all objects
 * that use the GenericPhy interface. The purpose of having such an
 * object is to allow making any PHY object that uses the GenericPhy
 * interface reachable through the attribute system via an upper
 * layer object (such as NetDevice), but without resorting to an
 * opaque Ptr<Object> which would give some problems.
 * See https://www.nsnam.org/bugzilla/show_bug.cgi?id=962 for the
 * related discussion.
 * 
 */
class GenericPhy : public Object
{
public:
  GenericPhy ();
  virtual ~GenericPhy ();

  // inherited from Object
  static TypeId GetTypeId (void);
};



} // namespace ns3



(-)a/src/network/wscript (+1 lines)

Lines 45-50	Link Here

        'utils/packet-socket-factory.cc',

        'utils/packet-socket-factory.cc',

        'utils/pcap-file.cc',

        'utils/pcap-file.cc',

        'utils/pcap-file-wrapper.cc',

        'utils/pcap-file-wrapper.cc',

        'utils/generic-phy.cc',

        'utils/queue.cc',

        'utils/queue.cc',

        'utils/radiotap-header.cc',

        'utils/radiotap-header.cc',

        'utils/simple-channel.cc',

        'utils/simple-channel.cc',

(-)a/src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.cc (-1 / +1 lines)

Lines 110-116	Link Here

110

      Ptr<HalfDuplexIdealPhy>  phy = (m_phy.Create ())->GetObject<HalfDuplexIdealPhy> ();

110

      Ptr<HalfDuplexIdealPhy>  phy = (m_phy.Create ())->GetObject<HalfDuplexIdealPhy> ();

111

      NS_ASSERT (phy);

111

      NS_ASSERT (phy);

112

113

      dev->SetPhy (phy);

113

      dev->SetPhy (phy->GetObject<GenericPhy> ());

114

115

      NS_ASSERT (node);

115

      NS_ASSERT (node);

116

      phy->SetMobility (node->GetObject<MobilityModel> ());

116

      phy->SetMobility (node->GetObject<MobilityModel> ());

(-)a/src/spectrum/helper/spectrum-analyzer-helper.cc (-1 / +3 lines)

Lines 29-34	Link Here

#include "ns3/non-communicating-net-device.h"

#include "ns3/non-communicating-net-device.h"

#include "ns3/output-stream-wrapper.h"

#include "ns3/output-stream-wrapper.h"

#include "ns3/trace-helper.h"

#include "ns3/trace-helper.h"

#include "ns3/generic-phy.h"

#include "spectrum-analyzer-helper.h"

#include "spectrum-analyzer-helper.h"

Lines 139-145	Link Here

139

      Ptr<SpectrumAnalyzer>  phy = m_phy.Create ()->GetObject<SpectrumAnalyzer> ();

141

      Ptr<SpectrumAnalyzer>  phy = m_phy.Create ()->GetObject<SpectrumAnalyzer> ();

140

      NS_ASSERT (phy);

142

      NS_ASSERT (phy);

141

143

142

      dev->SetPhy (phy);

144

      dev->SetPhy (phy->GetObject<GenericPhy> ());

143

145

144

      NS_ASSERT (node);

146

      NS_ASSERT (node);

145

      phy->SetMobility (node->GetObject<MobilityModel> ());

147

      phy->SetMobility (node->GetObject<MobilityModel> ());

(-)a/src/spectrum/helper/waveform-generator-helper.cc (-1 / +2 lines)

Lines 27-32	Link Here

#include "ns3/spectrum-channel.h"

#include "ns3/spectrum-channel.h"

#include "ns3/waveform-generator.h"

#include "ns3/waveform-generator.h"

#include "ns3/non-communicating-net-device.h"

#include "ns3/non-communicating-net-device.h"

#include "ns3/generic-phy.h"

#include "waveform-generator-helper.h"

#include "waveform-generator-helper.h"

Lines 95-101	Link Here

      Ptr<WaveformGenerator>  phy = m_phy.Create ()->GetObject<WaveformGenerator> ();

      Ptr<WaveformGenerator>  phy = m_phy.Create ()->GetObject<WaveformGenerator> ();

      NS_ASSERT (phy);

      NS_ASSERT (phy);

      dev->SetPhy (phy);

      dev->SetPhy (phy->GetObject<GenericPhy> ());

100

      NS_ASSERT (node);

101

      NS_ASSERT (node);

101

      phy->SetMobility (node->GetObject<MobilityModel> ());

102

      phy->SetMobility (node->GetObject<MobilityModel> ());




                   PointerValue (),
                   MakePointerAccessor (&AlohaNoackNetDevice::GetPhy,
                                        &AlohaNoackNetDevice::SetPhy),
                   MakePointerChecker<GenericPhy> ())
    .AddTraceSource ("MacTx",
                     "Trace source indicating a packet has arrived for transmission by this device",
                     MakeTraceSourceAccessor (&AlohaNoackNetDevice::m_macTxTrace))

}

void
AlohaNoackNetDevice::SetPhy (Ptr<GenericPhy> phy)
{
  NS_LOG_FUNCTION (this << phy);
  m_phy = phy;
}


Ptr<GenericPhy>
AlohaNoackNetDevice::GetPhy () const
{
  NS_LOG_FUNCTION (this);




   * callbacks, so we do not require that the PHY inherits by any
   * specific class.
   */
  void SetPhy (Ptr<GenericPhy> phy);

  /**
   * @return a reference to the PHY object embedded in this NetDevice.
   */
  Ptr<GenericPhy> GetPhy () const;





  Ptr<Packet> m_currentPkt;

  Ptr<GenericPhy> m_phy;
};



(-)a/src/spectrum/model/half-duplex-ideal-phy.cc (+5 lines)

Lines 45-50	Link Here

    m_state (IDLE)

    m_state (IDLE)

  m_interference.SetErrorModel (CreateObject<ShannonSpectrumErrorModel> ());

  m_interference.SetErrorModel (CreateObject<ShannonSpectrumErrorModel> ());

  // this allows to mark this object as being convertable to

  // GenericPhy (i.e., calling GetObject<GenericPhy> () returns

  // non-null) without inheriting from it (which would require

  // multiple inheritance)

  AggregateObject (CreateObject<GenericPhy> ());




#include "ns3/uinteger.h"
#include "ns3/pointer.h"
#include "ns3/channel.h"
#include "ns3/generic-phy.h"
#include "non-communicating-net-device.h"



                   PointerValue (),
                   MakePointerAccessor (&NonCommunicatingNetDevice::GetPhy,
                                        &NonCommunicatingNetDevice::SetPhy),
                   MakePointerChecker<GenericPhy> ())
  ;
  return tid;
}

}

void
NonCommunicatingNetDevice::SetPhy (Ptr<GenericPhy> phy)
{
  NS_LOG_FUNCTION (this << phy);
  m_phy = phy;
}


Ptr<GenericPhy>
NonCommunicatingNetDevice::GetPhy () const
{
  NS_LOG_FUNCTION (this);




class Channel;
class SpectrumErrorModel;
class Queue;
class GenericPhy;


/**

   *
   * @param phy the Phy object embedded within this device.
   */
  void SetPhy (Ptr<GenericPhy> phy);

  /**
   * @return a reference to the PHY object embedded in this NetDevice.
   */
  Ptr<GenericPhy> GetPhy () const;





  uint32_t m_ifIndex;

  Ptr<GenericPhy> m_phy;
};



(-)a/src/spectrum/model/spectrum-analyzer.cc (+6 lines)

Lines 24-29	Link Here

#include <ns3/double.h>

#include <ns3/double.h>

#include <ns3/simulator.h>

#include <ns3/simulator.h>

#include <ns3/trace-source-accessor.h>

#include <ns3/trace-source-accessor.h>

#include <ns3/generic-phy.h>

NS_LOG_COMPONENT_DEFINE ("SpectrumAnalyzer");

NS_LOG_COMPONENT_DEFINE ("SpectrumAnalyzer");

Lines 41-46	Link Here

    m_active (false)

    m_active (false)

  NS_LOG_FUNCTION (this);

  NS_LOG_FUNCTION (this);

  // this allows to mark this object as being convertable to

  // GenericPhy (i.e., calling GetObject<GenericPhy> () returns

  // non-null) without inheriting from it (which would require

  // multiple inheritance)

  AggregateObject (CreateObject<GenericPhy> ());

(-)a/src/spectrum/model/waveform-generator.cc (-2 / +6 lines)

Lines 24-30	Link Here

#include <ns3/simulator.h>

#include <ns3/simulator.h>

#include <ns3/double.h>

#include <ns3/double.h>

#include <ns3/packet-burst.h>

#include <ns3/packet-burst.h>

#include <ns3/generic-phy.h>

NS_LOG_COMPONENT_DEFINE ("WaveformGenerator");

NS_LOG_COMPONENT_DEFINE ("WaveformGenerator");

Lines 40-46	Link Here

    m_startTime (Seconds (0)),

    m_startTime (Seconds (0)),

    m_active (false)

    m_active (false)

  // this allows to mark this object as being convertable to

  // GenericPhy (i.e., calling GetObject<GenericPhy> () returns

  // non-null) without inheriting from it (which would require

  // multiple inheritance)

  AggregateObject (CreateObject<GenericPhy> ());

(-)a/src/spectrum/test/spectrum-ideal-phy-test.cc (-1 / +1 lines)

Lines 192-198	Link Here

192

  apps.Start (Seconds (0.0));

192

  apps.Start (Seconds (0.0));

193

  apps.Stop (Seconds (testDuration));

193

  apps.Stop (Seconds (testDuration));

194

195

  Config::Connect ("/NodeList/*/DeviceList/*/Phy/RxEndOk", MakeCallback (&PhyRxEndOkTrace));

195

  Config::Connect ("/NodeList/*/DeviceList/*/Phy/$ns3::HalfDuplexIdealPhy/RxEndOk", MakeCallback (&PhyRxEndOkTrace));

196

197

  g_rxBytes = 0;

197

  g_rxBytes = 0;

198

  Simulator::Stop (Seconds (testDuration+0.000000001));

198

  Simulator::Stop (Seconds (testDuration+0.000000001));

Return to bug 962