ns-3
ns3::UanPdp Class Reference

#include <uan-prop-model.h>

List of all members.

Public Types

typedef std::vector< Tap >
::const_iterator 
Iterator
 Iterator is a standard template library constant interator.

Public Member Functions

 UanPdp ()
 Create empty PDP object.
 UanPdp (std::vector< Tap > taps, Time resolution)
 Create PDP object from a vector of Tap objects.
 UanPdp (std::vector< std::complex< double > > arrivals, Time resolution)
 Create PDP object from vector of arrival amplitudes.
 UanPdp (std::vector< double > arrivals, Time resolution)
 Create PDP object from real valued arrival amplitudes.
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 TapGetTap (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 Public Member Functions

static UanPdp CreateImpulsePdp (void)

Friends

std::ostream & operator<< (std::ostream &os, UanPdp &pdp)
 Writes PDP to stream as list of arrivals.
std::istream & operator>> (std::istream &is, UanPdp &pdp)

Detailed Description

Container class to describe power delay profile returned from UAN propagation models using tapped delay line model. This should model a channel impulse response as a set of equally spaced signal arrivals.

Generally, the profile should be normalized, such that the sum of all taps should equal 1. The received signal power on any interval (t1, t2) can then be found from summing the taps on the interval and multiplying by the total received power at the receiver.


Constructor & Destructor Documentation

ns3::UanPdp::UanPdp ( std::vector< Tap taps,
Time  resolution 
)

Create PDP object from a vector of Tap objects.

Parameters:
tapsTaps to include in this PDP
resolutionResolution of PDP object
ns3::UanPdp::UanPdp ( std::vector< std::complex< double > >  arrivals,
Time  resolution 
)

Create PDP object from vector of arrival amplitudes.

Parameters:
arrivalsVector of complex amplitude arrivals
resolutionTime duration between arrivals in vector

References ns3::Seconds().

ns3::UanPdp::UanPdp ( std::vector< double >  arrivals,
Time  resolution 
)

Create PDP object from real valued arrival amplitudes.

Parameters:
arrivalsvector of real valued arrivals
resolutionTime duration between arrivals in vector

References ns3::Seconds().


Member Function Documentation

Returns:
A PDP with a singlue unit impulse arrival at time 0

References ns3::Seconds(), SetResolution(), and SetTap().

Referenced by ns3::UanPropModelThorp::GetPdp(), and ns3::UanPropModelIdeal::GetPdp().

Returns:
Iterator positioned at first arrival

Referenced by ns3::UanPhyCalcSinrFhFsk::CalcSinrDb().

Returns:
Iterator positioned after last arrival

Referenced by ns3::UanPhyCalcSinrFhFsk::CalcSinrDb().

uint32_t ns3::UanPdp::GetNTaps ( void  ) const
Returns:
Number of taps in PDP

Referenced by GetTap(), ns3::operator<<(), SumTapsC(), SumTapsFromMaxC(), SumTapsFromMaxNc(), and SumTapsNc().

Time ns3::UanPdp::GetResolution ( void  ) const
Returns:
Resolution of PDP (time duration between arrivals)

Referenced by ns3::operator<<().

const Tap & ns3::UanPdp::GetTap ( uint32_t  i) const
Returns:
Tap object at index i
Parameters:
iIndex number of tap to return (0 based)

References GetNTaps(), and NS_ASSERT_MSG.

void ns3::UanPdp::SetNTaps ( uint32_t  nTaps)
Parameters:
nTapsnumber of taps in this PDP
void ns3::UanPdp::SetResolution ( Time  resolution)
Parameters:
resolutionResolution of PDP (time between arrivals)

Referenced by CreateImpulsePdp().

void ns3::UanPdp::SetTap ( std::complex< double >  arrival,
uint32_t  index 
)
Parameters:
arrivalcomplex arrival value
indexindex of arrival

References ns3::Time::GetSeconds(), and ns3::Seconds().

Referenced by CreateImpulsePdp().

std::complex< double > ns3::UanPdp::SumTapsC ( Time  begin,
Time  end 
) const
Parameters:
beginTime value to begin summing arrivals
endTime value to end summing arrivals
Returns:
Returns coherent sum of arrivals between two time values

Assuming that Tap at index 0 arrives at time 0, this function sums coherently (sums amplitude of arrivals considering phase difference) all arrivals between a start and end time.

References GetNTaps(), ns3::Time::GetSeconds(), NS_ASSERT_MSG, and ns3::Seconds().

std::complex< double > ns3::UanPdp::SumTapsFromMaxC ( Time  delay,
Time  duration 
) const
Parameters:
delayTime duratation after max to begin summing arrivals
durationTime duration to sum arrivals for
Returns:
coherent sum of arrivals after max in given window

this function sums coherently (sums amplitude of arrivals considering phase difference) all arrivals in a given duration starting the given time after the maximum amplitude arrival received

References GetNTaps(), ns3::Time::GetSeconds(), NS_ASSERT_MSG, and ns3::Seconds().

double ns3::UanPdp::SumTapsFromMaxNc ( Time  delay,
Time  duration 
) const
Parameters:
delayTime duratation after max to begin summing arrivals
durationTime duration to sum arrivals for
Returns:
non-coherent sum of arrivals after max in given window

this function sums non-coherently (sums amplitude of arrivals ignoring phase difference) all arrivals in a given duration starting the given time after the maximum amplitude arrival received

References GetNTaps(), ns3::Time::GetSeconds(), NS_ASSERT_MSG, and ns3::Seconds().

Referenced by ns3::UanPhyCalcSinrFhFsk::CalcSinrDb().

double ns3::UanPdp::SumTapsNc ( Time  begin,
Time  end 
) const
Parameters:
beginTime value to begin summing arrivals
endTime value to end summing arrivals
Returns:
Returns Non-coherent sum of arrivals between two time values

Assuming that Tap at index 0 arrives at time 0, this function sums non-coherently (sums amplitude of arrivals ignoring phase difference) all arrivals between a start and end time.

References GetNTaps(), ns3::Time::GetSeconds(), NS_ASSERT_MSG, and ns3::Seconds().

Referenced by ns3::UanPhyCalcSinrFhFsk::CalcSinrDb().


The documentation for this class was generated from the following files: