spectrum-channel.h

Go to the documentation of this file.

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


#ifndef SPECTRUM_CHANNEL_H
#define SPECTRUM_CHANNEL_H

#include <ns3/object.h>
#include <ns3/nstime.h>
#include <ns3/channel.h>
#include <ns3/spectrum-signal-parameters.h>
#include <ns3/spectrum-propagation-loss-model.h>
#include <ns3/propagation-delay-model.h>
#include <ns3/propagation-loss-model.h>
#include <ns3/spectrum-phy.h>
#include <ns3/traced-callback.h>
#include <ns3/mobility-model.h>

namespace ns3 {


class PacketBurst;
class SpectrumValue;

class SpectrumChannel : public Channel
{
public:

  SpectrumChannel ();
  virtual ~SpectrumChannel ();

  // inherited from Object
  virtual void DoDispose (void);

  static TypeId GetTypeId (void);

  void AddPropagationLossModel (Ptr<PropagationLossModel> loss);

  void AddSpectrumPropagationLossModel (Ptr<SpectrumPropagationLossModel> loss);

  void SetPropagationDelayModel (Ptr<PropagationDelayModel> delay);

  Ptr<SpectrumPropagationLossModel> GetSpectrumPropagationLossModel (void);

  Ptr<PropagationLossModel> GetPropagationLossModel (void);

  virtual void StartTx (Ptr<SpectrumSignalParameters> params) = 0;

  virtual void AddRx (Ptr<SpectrumPhy> phy) = 0;

  typedef void (* LossTracedCallback)
    (Ptr<const SpectrumPhy> txPhy, Ptr<const SpectrumPhy> rxPhy,
     double lossDb);
  typedef void (* GainTracedCallback)
    (Ptr<const MobilityModel> txMobility, Ptr<const MobilityModel> rxMobility,
     double txAntennaGain, double rxAntennaGain,
     double propagationGain, double pathloss);
  typedef void (* SignalParametersTracedCallback) (Ptr<SpectrumSignalParameters> params);

protected:

  TracedCallback<Ptr<const SpectrumPhy>, Ptr<const SpectrumPhy>, double > m_pathLossTrace;

  TracedCallback<Ptr<const MobilityModel>, Ptr<const MobilityModel>, double, double, double, double> m_gainTrace;

  TracedCallback<Ptr<SpectrumSignalParameters> > m_txSigParamsTrace;

  double m_maxLossDb;

  Ptr<PropagationLossModel> m_propagationLoss;

  Ptr<PropagationDelayModel> m_propagationDelay;

  Ptr<SpectrumPropagationLossModel> m_spectrumPropagationLoss;


};


}


#endif /* SPECTRUM_CHANNEL_H */