uan-prop-model.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 University of Washington
 *
 * 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: Leonard Tracy <lentracy@gmail.com>
 */

#ifndef UAN_PROP_MODEL_H
#define UAN_PROP_MODEL_H

#include "ns3/object.h"
#include "ns3/mobility-model.h"
#include "ns3/nstime.h"


#include <vector>
#include <complex>
#include <utility>

namespace ns3 {

class UanTxMode;

class Tap
{
public:
  Tap ();
  Tap (Time delay, std::complex<double> amp);
  std::complex<double> GetAmp (void) const;
  Time GetDelay (void) const;

private:
  std::complex<double> m_amplitude;
  Time m_delay;
};

class UanPdp
{
public:
  typedef std::vector<Tap>::const_iterator Iterator;
  UanPdp ();
  UanPdp (std::vector<Tap> taps, Time resolution);
  UanPdp (std::vector<std::complex<double > > arrivals, Time resolution);
  UanPdp (std::vector<double> arrivals, Time resolution);
  ~UanPdp ();

  void SetTap (std::complex<double> arrival, uint32_t index);
  void SetNTaps (uint32_t nTaps);
  void SetResolution (Time resolution);
  Iterator GetBegin (void) const;
  Iterator GetEnd (void) const;
  uint32_t GetNTaps (void) const;
  const Tap &GetTap (uint32_t i) const;
  Time GetResolution (void) const;
  double SumTapsNc (Time begin, Time end) const;
  std::complex<double> SumTapsC (Time begin, Time end) const;
  double SumTapsFromMaxNc (Time delay, Time duration) const;
  std::complex<double> SumTapsFromMaxC (Time delay, Time duration) const;

  static UanPdp CreateImpulsePdp (void);
private:
  friend std::ostream &operator<< (std::ostream &os, UanPdp &pdp);
  friend std::istream &operator>> (std::istream &is, UanPdp &pdp);
  std::vector<Tap> m_taps;
  Time m_resolution;

};
std::ostream &operator<< (std::ostream &os, UanPdp &pdp);
std::istream &operator>> (std::ostream &is, UanPdp &pdp);

class UanPropModel : public Object
{
public:
  static TypeId GetTypeId (void);

  virtual double GetPathLossDb (Ptr<MobilityModel> a, Ptr<MobilityModel> b, UanTxMode txMode) = 0;

  virtual UanPdp GetPdp (Ptr<MobilityModel> a, Ptr<MobilityModel> b, UanTxMode mode) = 0;
  virtual Time GetDelay (Ptr<MobilityModel> a, Ptr<MobilityModel> b, UanTxMode mode) = 0;

  virtual void Clear (void);

  virtual void DoDispose (void);
};

}

#endif /* UAN_PROP_MODEL_H */