SatUtils class is for general conversions used in satellite module. More...

#include "satellite-utils.h"

Static Public Member Functions
template<typename T>
static T	DbmToW (T dbm)
	Converts Decibel milli Watts to Watts.
template<typename T>
static T	DbToLinear (T db)
	Converts decibels to linear.
template<typename T>
static T	DbWToW (T dbw)
	Converts Decibel Watts to Watts.
template<typename T>
static T	DegreesToRadians (T degree)
	Converts degrees to radians.
static double	GetCodingRate (SatEnums::SatModcod_t modcod)
	Gets the coding rate of a certain MODCOD.
static SatEnums::SatBbFrameType_t	GetFrameTypeS2X (SatEnums::SatModcod_t modcod)
static uint32_t	GetModulatedBits (SatEnums::SatModcod_t modcod)
	Get the modulated bits of a certain MODCOD.
static std::string	GetPacketInfo (const Ptr< const Packet > p)
	Get packet information in std::string for printing purposes.
static std::string	GetPacketInfo (const std::vector< Ptr< Packet > > packets)
	Gets packet information in std::string for printing purposes.
static double	Interpolate (double x, double x0, double x1, double y0, double y1)
	Simple linear interpolation.
template<typename T>
static T	LinearToDb (T linear)
	Converts linear to decibels.
template<typename T>
static T	MaxDb ()
	Get maximum value for Decibel.
template<typename T>
static T	MaxLin ()
	Get maximum value for linear.
template<typename T>
static T	MinDb ()
	Get minimum value for Decibel.
template<typename T>
static T	MinLin ()
	Get minimum value for linear.
template<typename T>
static T	RadiansToDegrees (T radian)
	Converts radians to degrees.
static double	ScalarProduct (const std::vector< std::pair< double, double > > &vector)
	Scalar product.
template<typename T>
static T	WToDbm (T w)
	Converts Watts to Decibel milli Watts.
template<typename T>
static T	WToDbW (T w)
	Converts Watts to Decibel Watts.

Private Member Functions
virtual	~SatUtils ()=0
	Destructor.

Detailed Description

SatUtils class is for general conversions used in satellite module.

This class is not planned to be instantiated or inherited.

Definition at line 46 of file satellite-utils.h.

Constructor & Destructor Documentation

◆ ~SatUtils()

virtual ns3::SatUtils::~SatUtils ( )

privatepure virtual

Destructor.

Made Pure Virtual because the class is not planned be instantiated or inherited

Member Function Documentation

◆ DbmToW()

template<typename T>

T ns3::SatUtils::DbmToW ( T dbm )

inlinestatic

Converts Decibel milli Watts to Watts.

Parameters

dbm	value in Decibel milli Watts to convert

Returns: Watts converted from Decibel milli Watts

Definition at line 187 of file satellite-utils.h.

References DbWToW().

Here is the call graph for this function:

◆ DbToLinear()

template<typename T>

T ns3::SatUtils::DbToLinear ( T db )

inlinestatic

Converts decibels to linear.

Accepted values for conversion are between minimum decibel value and maximum decibel value. Negative infinity is also an accepted value and it is converted to zero.

Parameters

db	value in Decibels to convert

Returns: linear converted from Decibels

Definition at line 151 of file satellite-utils.h.

References MaxDb(), and MinDb().

Referenced by SatFrameAllocatorTestCase::SatFrameAllocatorTestCase(), DbWToW(), SatDvbRcs2WaveformTableTestCase::DoRun(), ns3::SatAntennaGainPattern::GetAntennaGain_lin(), ns3::SatPhyRxCarrierPerWindow::GetEffectiveSnir(), ns3::SatFadingExternalInputTrace::GetFading(), ns3::SatBbFrameConf::InitializeCNoRequirements(), ns3::SatWaveformConf::InitializeEbNoRequirements(), ns3::SatGwPhy::NotifyConstructionCompleted(), ns3::SatOrbiterFeederPhy::NotifyConstructionCompleted(), ns3::SatOrbiterUserPhy::NotifyConstructionCompleted(), ns3::SatUtPhy::NotifyConstructionCompleted(), ns3::SatPhyRxCarrierPerSlot::ReceiveSlot(), ns3::SatOrbiterFeederPhy::SendPduWithParams(), ns3::SatPhyRx::SetAntennaLoss_Db(), and ns3::SatPhyTx::SetMaxAntennaGain_Db().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DbWToW()

template<typename T>

T ns3::SatUtils::DbWToW ( T dbw )

inlinestatic

Converts Decibel Watts to Watts.

Parameters

dbw	value in Decibel Watts to convert

Returns: Watts converted from Decibel Watts

Definition at line 124 of file satellite-utils.h.

References DbToLinear().

Referenced by DbmToW(), ns3::SatPhy::Initialize(), and ns3::SatPhyRx::SetMaxAntennaGain_Db().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DegreesToRadians()

template<typename T>

T ns3::SatUtils::DegreesToRadians ( T degree )

inlinestatic

Converts degrees to radians.

Parameters

degree value to convert as degrees

Returns: radians converted from degrees

Definition at line 68 of file satellite-utils.h.

Referenced by ns3::GeoCoordinate::ToVector(), and ns3::SatMobilityObserver::UpdateElevationAngle().

Here is the caller graph for this function:

◆ GetCodingRate()

double ns3::SatUtils::GetCodingRate ( SatEnums::SatModcod_t modcod )

inlinestatic

Gets the coding rate of a certain MODCOD.

Parameters

modcod Modulation and coding scheme

Returns: double coding rate

Definition at line 544 of file satellite-utils.h.

Referenced by ns3::SatBbFrameConf::CalculateBbFramePayloadBits(), ns3::SatPhyRxCarrier::CheckAgainstLinkResultsErrorModelAvi(), ns3::LorawanGroundMacGateway::Send(), ns3::LorawanMacGateway::Send(), ns3::LorawanOrbiterMacGateway::Send(), and ns3::LorawanMacEndDeviceClassA::SendToPhy().

Here is the caller graph for this function:

◆ GetFrameTypeS2X()

SatEnums::SatBbFrameType_t ns3::SatUtils::GetFrameTypeS2X ( SatEnums::SatModcod_t modcod )

inlinestatic

Definition at line 920 of file satellite-utils.h.

Referenced by ns3::SatBbFrameConf::NotifyConstructionCompleted().

Here is the caller graph for this function:

◆ GetModulatedBits()

uint32_t ns3::SatUtils::GetModulatedBits ( SatEnums::SatModcod_t modcod )

inlinestatic

Get the modulated bits of a certain MODCOD.

Parameters

modcod Modulation and coding scheme

Returns: Modulated bits

Definition at line 246 of file satellite-utils.h.

Referenced by ns3::SatBbFrameConf::CalculateBbFrameDuration(), ns3::SatBbFrameConf::CalculateBbFramePayloadBits(), and ns3::SatPhyRxCarrier::CheckAgainstLinkResultsErrorModelAvi().

Here is the caller graph for this function:

◆ GetPacketInfo() [1/2]

std::string ns3::SatUtils::GetPacketInfo ( const Ptr< const Packet > p )

inlinestatic

Get packet information in std::string for printing purposes.

Parameters

p Packet

Returns: Packet information in std::string

Definition at line 210 of file satellite-utils.h.

References ns3::SatMacTag::GetDestAddress(), and ns3::SatMacTag::GetSourceAddress().

Referenced by ns3::SatUtMac::DoEssaTransmit(), ns3::SatUtMac::DoSlottedAlohaTransmit(), ns3::SatGwLlc::Enque(), ns3::SatLlc::Enque(), ns3::SatOrbiterLlc::Enque(), ns3::SatUtLlc::Enque(), ns3::SatUtMac::FetchPackets(), GetPacketInfo(), ns3::SatGwLlc::NotifyTxOpportunity(), ns3::SatOrbiterLlc::NotifyTxOpportunity(), ns3::SatUtLlc::NotifyTxOpportunity(), ns3::SatGwMac::Receive(), ns3::SatLlc::Receive(), ns3::SatLorawanNetDevice::Receive(), ns3::SatNetDevice::Receive(), ns3::SatOrbiterFeederMac::Receive(), ns3::SatOrbiterFeederPhy::Receive(), ns3::SatOrbiterUserMac::Receive(), ns3::SatOrbiterUserPhy::Receive(), ns3::SatPhy::Receive(), ns3::SatUtMac::Receive(), ns3::SatOrbiterNetDeviceDvb::ReceivePacketFeeder(), ns3::SatOrbiterNetDeviceLora::ReceivePacketFeeder(), ns3::SatOrbiterNetDeviceDvb::ReceivePacketUser(), ns3::SatOrbiterNetDeviceLora::ReceivePacketUser(), ns3::SatLorawanNetDevice::Send(), ns3::SatNetDevice::Send(), ns3::SatNetDevice::SendControlMsg(), ns3::SatNetDevice::SendFrom(), ns3::SatOrbiterFeederPhy::SendFromQueue(), ns3::SatOrbiterUserPhy::SendFromQueue(), ns3::SatOrbiterMac::SendPacket(), ns3::SatPhy::SendPdu(), ns3::SatOrbiterFeederPhy::SendPduWithParams(), ns3::SatOrbiterUserPhy::SendPduWithParams(), and ns3::SatGwMac::StartTransmission().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPacketInfo() [2/2]

std::string ns3::SatUtils::GetPacketInfo ( const std::vector< Ptr< Packet > > packets )

inlinestatic

Gets packet information in std::string for printing purposes.

Parameters

packets A vector of packets

Returns: Packet information in std::string

Definition at line 229 of file satellite-utils.h.

References GetPacketInfo().

Here is the call graph for this function:

◆ Interpolate()

double ns3::SatUtils::Interpolate	(	double	x,
		double	x0,
		double	x1,
		double	y0,
		double	y1 )

inlinestatic

Simple linear interpolation.

y = y0 + (y1-y0)*(x-x0)/(x1-x0) http://en.wikipedia.org/wiki/Linear_interpolation

Parameters

x	Interpolated x
x0	Lower x value
x1	Higher x value
y0	Lower y value
y1	Higher y value

Returns: Interpolated value

Definition at line 1164 of file satellite-utils.h.

Referenced by ns3::SatChannelEstimationError::AddError(), ns3::SatLookUpTable::GetBler(), ns3::SatLookUpTable::GetEsNoDb(), ns3::SatMutualInformationTable::GetNormalizedSymbolInformation(), and ns3::SatMutualInformationTable::GetSnirDb().

Here is the caller graph for this function:

◆ LinearToDb()

template<typename T>

T ns3::SatUtils::LinearToDb ( T linear )

inlinestatic

Converts linear to decibels.

Accepted values for conversion are between minimum linear value (greater than zero and maximum linear value. Zero is also accepted and it is converted to -INF.

Parameters

linear value to convert

Returns: Decibels converted from linear

Definition at line 170 of file satellite-utils.h.

References MaxLin(), and MinLin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MaxDb()

template<typename T>

T ns3::SatUtils::MaxDb ( )

inlinestatic

Get maximum value for Decibel.

Returns: maximum Decibel value

Definition at line 112 of file satellite-utils.h.

References LinearToDb(), and MaxLin().

Referenced by DbToLinear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MaxLin()

template<typename T>

T ns3::SatUtils::MaxLin ( )

inlinestatic

Get maximum value for linear.

Returns: maximum linear value

Definition at line 90 of file satellite-utils.h.

Referenced by LinearToDb(), and MaxDb().

Here is the caller graph for this function:

◆ MinDb()

template<typename T>

T ns3::SatUtils::MinDb ( )

inlinestatic

Get minimum value for Decibel.

Returns: minimum Decibel value

Definition at line 101 of file satellite-utils.h.

References LinearToDb(), and MinLin().

Referenced by DbToLinear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MinLin()

template<typename T>

T ns3::SatUtils::MinLin ( )

inlinestatic

Get minimum value for linear.

(The smallest value greater than zero)

Returns: minimum linear value

Definition at line 79 of file satellite-utils.h.

Referenced by LinearToDb(), and MinDb().

Here is the caller graph for this function:

◆ RadiansToDegrees()

template<typename T>

T ns3::SatUtils::RadiansToDegrees ( T radian )

inlinestatic

Converts radians to degrees.

Parameters

radian value to convert as radians

Returns: degrees converted from radians

Definition at line 56 of file satellite-utils.h.

Referenced by ns3::GeoCoordinate::ConstructFromVector(), and ns3::SatMobilityObserver::UpdateElevationAngle().

Here is the caller graph for this function:

◆ ScalarProduct()

double ns3::SatUtils::ScalarProduct ( const std::vector< std::pair< double, double > > & vector )

inlinestatic

Scalar product.

Parameters

vector Array of pairs of doubles

Returns: Sum of the product of each pair elements

Definition at line 1178 of file satellite-utils.h.

Referenced by ns3::SatPhyRxCarrierPerWindow::CalculatePacketInterferenceVectors(), ns3::SatPerfectInterferenceElimination::EliminateInterferences(), ns3::SatResidualInterferenceElimination::EliminateInterferences(), ns3::SatSignalParameters::SetInterferencePower(), and ns3::SatSignalParameters::SetInterferencePowerInSatellite().

Here is the caller graph for this function:

◆ WToDbm()

template<typename T>

T ns3::SatUtils::WToDbm ( T w )

inlinestatic

Converts Watts to Decibel milli Watts.

Parameters

w	value in Watts to convert

Returns: Decibel milli Watts converted from Watts

Definition at line 199 of file satellite-utils.h.

References WToDbW().

Here is the call graph for this function:

◆ WToDbW()

template<typename T>

T ns3::SatUtils::WToDbW ( T w )

inlinestatic

Converts Watts to Decibel Watts.

Parameters

w	value in Watts to convert

Returns: Decibel Watts converted from Watts

Definition at line 136 of file satellite-utils.h.

References LinearToDb().

Referenced by LinkBudgetTraceCb(), LinkBudgetTraceCb(), and WToDbm().

Here is the call graph for this function:

Here is the caller graph for this function:

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

/builds/sns3/satellite/satellite/model/satellite-utils.h

Static Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~SatUtils()

Member Function Documentation

◆ DbmToW()

◆ DbToLinear()

◆ DbWToW()

◆ DegreesToRadians()

◆ GetCodingRate()

◆ GetFrameTypeS2X()

◆ GetModulatedBits()

◆ GetPacketInfo() [1/2]

◆ GetPacketInfo() [2/2]

◆ Interpolate()

◆ LinearToDb()

◆ MaxDb()

◆ MaxLin()

◆ MinDb()

◆ MinLin()

◆ RadiansToDegrees()

◆ ScalarProduct()

◆ WToDbm()

◆ WToDbW()