The SatOrbiterFeederPhy models the feeder link physical layer of the satellite node. More...

#include "satellite-orbiter-feeder-phy.h"

Inheritance diagram for ns3::SatOrbiterFeederPhy:

Collaboration diagram for ns3::SatOrbiterFeederPhy:

Public Types
typedef void(*	QueueSizeCallback) (uint32_t size, const Address &from)
	Callback signature for `QueueSizeBytes` and `QueueSizePackets` trace source. More...

Public Types inherited from ns3::SatPhy
typedef Callback< void, uint32_t, uint32_t, uint32_t, uint8_t, double >	AverageNormalizedOfferedLoadCallback

typedef Callback< SatChannelPair::ChannelPair_t, uint32_t, uint32_t >	ChannelPairGetterCallback
	Callback for retrieving a pair of SatChannel associated to a beam. More...

typedef Callback< void, uint32_t, uint32_t, Address, Address, double, bool >	CnoCallback

typedef SatPhyRxCarrierConf::ErrorModel	ErrorModel
	Define ErrorModel in SatPhy. More...

typedef SatPhyRxCarrierConf::InterferenceEliminationModel	InterferenceEliminationModel
	Define InterferenceEliminationModel in SatPhy. More...

typedef SatPhyRxCarrierConf::InterferenceModel	InterferenceModel
	Define InterferenceModel in SatPhy. More...

typedef SatSignalParameters::PacketsInBurst_t	PacketContainer_t
	Define PacketContainer in SatPhy. More...

typedef Callback< void, PacketContainer_t, Ptr< SatSignalParameters > >	ReceiveCallback

Public Member Functions
	SatOrbiterFeederPhy (SatPhy::CreateParam_t &params, Ptr< SatLinkResults > linkResults, SatPhyRxCarrierConf::RxCarrierCreateParams_s parameters, Ptr< SatSuperframeConf > superFrameConf)

	SatOrbiterFeederPhy (void)
	Default constructor. More...

virtual	~SatOrbiterFeederPhy ()
	Destructor for SatOrbiterFeederPhy. More...

virtual void	DoDispose (void)
	Dispose of this class instance. More...

virtual void	DoInitialize (void)
	Initialization of SatPhy. More...

virtual double	GetAdditionalInterference ()
	Get additional interference, used to compute final SINR at RX. More...

TypeId	GetInstanceTypeId (void) const

virtual void	Receive (Ptr< SatSignalParameters > rxParams, bool phyError)
	Receives packets from lower layer. More...

virtual void	SendPduWithParams (Ptr< SatSignalParameters > rxParams)
	Send Pdu to the PHY tx module (for satellite switch packet forwarding) More...

Public Member Functions inherited from ns3::SatPhy
	SatPhy (CreateParam_t &params)
	Constructor to create PHY objects with parameters. More...

	SatPhy (void)
	Default constructor. More...

virtual	~SatPhy ()
	Destructor. More...

void	AverageNormalizedOfferedRandomAccessLoadInfo (uint32_t satId, uint32_t beamId, uint32_t carrierId, uint8_t allocationChannelId, double averageNormalizedOfferedLoad)
	Function for getting the normalized offered load of the specific random access allocation channel. More...

void	BeginEndScheduling ()
	Begin frame/window end scheduling for processes utilizing frame length as interval. More...

double	CalculateSinr (double sinr, double otherInterference)
	Calculate final SINR with PHY specific parameters and given calculated SINR. More...

void	CnoInfo (uint32_t satId, uint32_t beamId, Address source, Address destination, double cno, bool isSatelliteMac)
	Function for getting the C/NO information. More...

void	ConfigureRxCarriers (Ptr< SatPhyRxCarrierConf > carrierConf, Ptr< SatSuperframeConf > superFrameConf)
	Configure Rx carriers. More...

double	GetDefaultFading () const
	Get the default fading of the PHY. More...

TypeId	GetInstanceTypeId (void) const
	Derived from Object. More...

virtual Ptr< SatPhyRx >	GetPhyRx () const
	Get the SatPhyRx pointer. More...

virtual Ptr< SatPhyTx >	GetPhyTx () const
	Get the SatPhyTx pointer. More...

double	GetRxAntennaGainDb () const
	Get the maximum antenna gain of the receiver in dB. More...

double	GetRxAntennaLossDb () const
	Get the antenna loss of the receiver in dB. More...

double	GetRxNoiseTemperatureDbk () const
	Get the noise temperature of the receiver in dbK. More...

double	GetTxAntennaGainDb () const
	Get the maximum antenna gain of the transmitter in dB. More...

double	GetTxAntennaLossDb () const
	Get the antenna loss of the transmitter in dB. More...

Ptr< SatChannel >	GetTxChannel ()
	Get the Tx satellite channel. More...

double	GetTxMaxPowerDbw () const
	Get the maximum transmit power of the transmitter in dB. More...

double	GetTxOboLossDb () const
	Get the OBO loss of the transmitter in dB. More...

double	GetTxOutputLossDb () const
	Get the output loss of the transmitter in dB. More...

double	GetTxPointingLossDb () const
	Get the pointing loss of the transmitter in dB. More...

void	Initialize ()
	Initialize phy. More...

virtual void	SendPdu (PacketContainer_t, uint32_t carrierId, Time duration, SatSignalParameters::txInfo_s txInfo)
	Send Pdu to the PHY tx module (for initial transmissions from either UT or GW) More...

bool	SetBeamId (uint32_t beamId)
	Set the beamId this PHY is connected with. More...

void	SetChannelPairGetterCallback (SatPhy::ChannelPairGetterCallback cb)
	Set the channel pair getter callback. More...

void	SetDefaultFading (double fading)
	Set the default fading of the PHY. More...

void	SetNodeInfo (const Ptr< SatNodeInfo > nodeInfo)
	Set the node info class. More...

virtual void	SetPhyRx (Ptr< SatPhyRx > phyRx)
	Set the SatPhyRx module. More...

virtual void	SetPhyTx (Ptr< SatPhyTx > phyTx)
	Set the SatPhyTx module. More...

void	SetRxAntennaGainDb (double gainDb)
	Set the maximum antenna gain of the receiver in dB. More...

virtual void	SetRxAntennaGainPattern (Ptr< SatAntennaGainPattern > agp, Ptr< SatMobilityModel > satelliteMobility)
	Set the receive antenna gain pattern. More...

void	SetRxAntennaLossDb (double lossDb)
	Set the antenna loss of the receiver in dB. More...

void	SetRxFadingContainer (Ptr< SatBaseFading > fadingContainer)
	Set fading container. More...

void	SetRxNoiseTemperatureDbk (double temperatureDbk)
	Set the noise temperature of the receiver in dbK. More...

void	SetSatId (uint32_t satId)
	Set the satId this PHY is connected with. More...

void	SetTxAntennaGainDb (double gainDb)
	Set the maximum antenna gain of the transmitter in dB. More...

virtual void	SetTxAntennaGainPattern (Ptr< SatAntennaGainPattern > agp, Ptr< SatMobilityModel > satelliteMobility)
	Set the transmit antenna gain pattern. More...

void	SetTxAntennaLossDb (double lossDb)
	Set the antenna loss of the transmitter in dB. More...

void	SetTxFadingContainer (Ptr< SatBaseFading > fadingContainer)
	Set fading container. More...

void	SetTxMaxPowerDbw (double powerDb)
	Set the maximum transmit power of the transmitter in dB. More...

void	SetTxOboLossDb (double lossDb)
	Set the OBO loss of the transmitter in dB. More...

void	SetTxOutputLossDb (double lossDb)
	Set the output loss of the transmitter in dB. More...

void	SetTxPointingLossDb (double lossDb)
	Set the pointing loss of the transmitter in dB. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	inherited from Object More...

Static Public Member Functions inherited from ns3::SatPhy
static TypeId	GetTypeId (void)
	Derived from Object. More...

Protected Member Functions
virtual SatEnums::SatLinkDir_t	GetSatLinkRxDir ()
	Get the link RX direction. More...

virtual SatEnums::SatLinkDir_t	GetSatLinkTxDir ()
	Get the link TX direction. More...

virtual void	RxTraces (SatPhy::PacketContainer_t packets)
	Invoke the `Rx` trace source for each received packet. More...

Protected Member Functions inherited from ns3::SatPhy
void	ModcodTrace (Ptr< SatSignalParameters > rxParams)
	Invoke the `RxLinkModcod` trace source for each received packet. More...

void	SetTimeTag (SatPhy::PacketContainer_t packets)
	Set SatPhyTimeTag of packets. More...

Protected Attributes
TracedCallback< uint32_t, const Address & >	m_queueSizeBytesTrace
	Traced callback to monitor RTN feeder queue size in bytes. More...

TracedCallback< uint32_t, const Address & >	m_queueSizePacketsTrace
	Traced callback to monitor RTN feeder queue size in packets. More...

Protected Attributes inherited from ns3::SatPhy
uint32_t	m_beamId
	Beam ID. More...

double	m_eirpWoGainW
	Calculated EIRP without gain in W. More...

bool	m_isStatisticsTagsEnabled
	`EnableStatisticsTags` attribute. More...

Time	m_lastDelay
	Last delay measurement. More...

Time	m_lastLinkDelay
	Last delay measurement for link. More...

Ptr< SatNodeInfo >	m_nodeInfo
	Node info containing node related information, such as node type, node id and MAC address (of the SatNetDevice) More...

TracedCallback< Time, SatEnums::SatPacketEvent_t, SatEnums::SatNodeType_t, uint32_t, Mac48Address, SatEnums::SatLogLevel_t, SatEnums::SatLinkDir_t, std::string >	m_packetTrace
	Trace callback used for packet tracing: More...

Ptr< SatPhyRx >	m_phyRx
	Pointer to internal SatPhyRx instance. More...

Ptr< SatPhyTx >	m_phyTx
	Pointer to internal SatPhyTx instance. More...

SatPhy::ChannelPairGetterCallback	m_retrieveChannelPair
	Callback for retrieving SatChannel pairs by beam. More...

SatPhy::ReceiveCallback	m_rxCallback
	The upper layer package receive callback. More...

TracedCallback< const Time &, const Address & >	m_rxDelayTrace
	Traced callback for all received packets, including delay information and the address of the senders. More...

TracedCallback< const Time &, const Address & >	m_rxJitterTrace
	Traced callback for all received packets, including jitter information and the address of the senders. More...

TracedCallback< const Time &, const Address & >	m_rxLinkDelayTrace
	Traced callback for all received packets, including link delay information and the address of the senders. More...

TracedCallback< const Time &, const Address & >	m_rxLinkJitterTrace
	Traced callback for all received packets, including link jitter information and the address of the senders. More...

TracedCallback< uint32_t, const Address & >	m_rxLinkModcodTrace
	Traced callback for all received packets, including link MODCOD information and the address of the senders. More...

TracedCallback< Ptr< const Packet >, const Address & >	m_rxTrace
	Traced callback for all received packets, including the address of the senders. More...

uint32_t	m_satId
	Satellite ID. More...

Private Member Functions
void	EndTx ()
	Notify a packet has finished being sent. More...

Address	GetE2ESourceAddress (SatPhy::PacketContainer_t packets)
	Get source address of packets. More...

void	SendFromQueue ()
	Send a packet from the queue. More...

Private Attributes
double	m_extNoisePowerDensityDbwHz
	Configured external noise power. More...

double	m_fixedAmplificationGainDb
	Fixed amplification gain used in RTN link at the satellite. More...

SatEnums::RegenerationMode_t	m_forwardLinkRegenerationMode
	Regeneration mode on forward link. More...

double	m_imInterferenceCOverI
	Intermodulation interference in linear. More...

double	m_imInterferenceCOverIDb
	Configured Intermodulation interference in dB. More...

bool	m_isSending
	Indicates if a packet is already being sent. More...

std::queue< std::tuple< Ptr< SatSignalParameters >, uint32_t, uint32_t > >	m_queue
	Simple FIFO queue to avoid collisions on TX in case of REGENERATION_PHY. More...

uint32_t	m_queueSizeBytes
	Size of FIFO queue in bytes. More...

uint32_t	m_queueSizeMax
	Maximum size of FIFO m_queue in bytes. More...

uint32_t	m_queueSizePackets
	Size of FIFO queue in packets. More...

SatEnums::RegenerationMode_t	m_returnLinkRegenerationMode
	Regeneration mode on return link. More...

Detailed Description

The SatOrbiterFeederPhy models the feeder link physical layer of the satellite node.

Definition at line 54 of file satellite-orbiter-feeder-phy.h.

Member Typedef Documentation

◆ QueueSizeCallback

typedef void(* ns3::SatOrbiterFeederPhy::QueueSizeCallback) (uint32_t size, const Address &from)

Callback signature for QueueSizeBytes and QueueSizePackets trace source.

Parameters

size	number of bytes or number of packets of queue
from	The MAC source address of packets

Definition at line 113 of file satellite-orbiter-feeder-phy.h.

Constructor & Destructor Documentation

◆ SatOrbiterFeederPhy() [1/2]

ns3::SatOrbiterFeederPhy::SatOrbiterFeederPhy ( void )

Default constructor.

Definition at line 168 of file satellite-orbiter-feeder-phy.cc.

◆ SatOrbiterFeederPhy() [2/2]

ns3::SatOrbiterFeederPhy::SatOrbiterFeederPhy	(	SatPhy::CreateParam_t &	params,
		Ptr< SatLinkResults >	linkResults,
		SatPhyRxCarrierConf::RxCarrierCreateParams_s	parameters,
		Ptr< SatSuperframeConf >	superFrameConf
	)

◆ ~SatOrbiterFeederPhy()

ns3::SatOrbiterFeederPhy::~SatOrbiterFeederPhy ( )

virtual

Destructor for SatOrbiterFeederPhy.

Definition at line 242 of file satellite-orbiter-feeder-phy.cc.

Member Function Documentation

◆ DoDispose()

void ns3::SatOrbiterFeederPhy::DoDispose ( void )

virtual

Dispose of this class instance.

Reimplemented from ns3::SatPhy.

Definition at line 248 of file satellite-orbiter-feeder-phy.cc.

◆ DoInitialize()

void ns3::SatOrbiterFeederPhy::DoInitialize ( void )

virtual

Initialization of SatPhy.

Reimplemented from ns3::SatPhy.

Definition at line 255 of file satellite-orbiter-feeder-phy.cc.

◆ EndTx()

void ns3::SatOrbiterFeederPhy::EndTx ( )

private

Notify a packet has finished being sent.

Used only in REGENERATION_PHY mode.

Definition at line 384 of file satellite-orbiter-feeder-phy.cc.

References m_isSending, m_queue, and SendFromQueue().

Referenced by SendFromQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAdditionalInterference()

double ns3::SatOrbiterFeederPhy::GetAdditionalInterference ( )

virtual

Get additional interference, used to compute final SINR at RX.

Returns: Additional interference

Implements ns3::SatPhy.

Definition at line 492 of file satellite-orbiter-feeder-phy.cc.

References m_imInterferenceCOverI.

Referenced by SatOrbiterFeederPhy().

Here is the caller graph for this function:

◆ GetE2ESourceAddress()

Address ns3::SatOrbiterFeederPhy::GetE2ESourceAddress ( SatPhy::PacketContainer_t packets )

private

Get source address of packets.

packets The packets from where extract source

Returns: The source MAC address

Definition at line 512 of file satellite-orbiter-feeder-phy.cc.

References ns3::SatAddressTag::GetSourceAddress(), and ns3::SatAddressTag::GetTypeId().

Referenced by SendFromQueue(), and SendPduWithParams().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SatOrbiterFeederPhy::GetInstanceTypeId ( void ) const

Definition at line 161 of file satellite-orbiter-feeder-phy.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSatLinkRxDir()

SatEnums::SatLinkDir_t ns3::SatOrbiterFeederPhy::GetSatLinkRxDir ( )

protectedvirtual

Get the link RX direction.

Must be implemented by child clases.

Returns: The link RX direction

Reimplemented from ns3::SatPhy.

Definition at line 506 of file satellite-orbiter-feeder-phy.cc.

References ns3::SatEnums::LD_FORWARD.

◆ GetSatLinkTxDir()

SatEnums::SatLinkDir_t ns3::SatOrbiterFeederPhy::GetSatLinkTxDir ( )

protectedvirtual

Get the link TX direction.

Must be implemented by child clases.

Returns: The link TX direction

Reimplemented from ns3::SatPhy.

Definition at line 500 of file satellite-orbiter-feeder-phy.cc.

References ns3::SatEnums::LD_RETURN.

◆ GetTypeId()

TypeId ns3::SatOrbiterFeederPhy::GetTypeId ( void )

static

inherited from Object

Definition at line 56 of file satellite-orbiter-feeder-phy.cc.

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Receive()

void ns3::SatOrbiterFeederPhy::Receive	(	Ptr< SatSignalParameters >	rxParams,
		bool	phyError
	)

virtual

Receives packets from lower layer.

Parameters

rxParams	Packet reception parameters
phyError	Boolean indicating whether the packet successfully received or not? Note, that this parameter is not used in the satellite, but exists since we are using a general interface defined in the parent class.

Reimplemented from ns3::SatPhy.

Definition at line 434 of file satellite-orbiter-feeder-phy.cc.

References ns3::SatUtils::GetPacketInfo(), ns3::SatEnums::LD_FORWARD, ns3::SatEnums::LL_PHY, m_forwardLinkRegenerationMode, ns3::SatPhy::m_nodeInfo, ns3::SatPhy::m_packetTrace, ns3::SatPhy::m_rxCallback, ns3::SatPhy::ModcodTrace(), ns3::SatEnums::PACKET_DROP, ns3::SatEnums::PACKET_RECV, ns3::SatEnums::PACKET_TYPE_DEDICATED_ACCESS, ns3::SatEnums::REGENERATION_NETWORK, ns3::SatEnums::REGENERATION_PHY, RxTraces(), ns3::SatUplinkInfoTag::SetBeamId(), ns3::SatUplinkInfoTag::SetSatId(), and ns3::SatEnums::TRANSPARENT.

Here is the call graph for this function:

◆ RxTraces()

void ns3::SatOrbiterFeederPhy::RxTraces ( SatPhy::PacketContainer_t packets )

protectedvirtual

Invoke the Rx trace source for each received packet.

Parameters

packets Container of the pointers to the packets received.

Reimplemented from ns3::SatPhy.

Definition at line 394 of file satellite-orbiter-feeder-phy.cc.

References ns3::SatAddressE2ETag::GetE2EDestAddress(), ns3::SatPhyLinkTimeTag::GetSenderLinkTimestamp(), ns3::SatPhy::m_isStatisticsTagsEnabled, ns3::SatPhy::m_lastLinkDelay, ns3::SatPhy::m_rxLinkDelayTrace, ns3::SatPhy::m_rxLinkJitterTrace, and ns3::SatPhy::m_rxTrace.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendFromQueue()

void ns3::SatOrbiterFeederPhy::SendFromQueue ( )

private

Send a packet from the queue.

Used only in REGENERATION_PHY mode.

Definition at line 351 of file satellite-orbiter-feeder-phy.cc.

References EndTx(), GetE2ESourceAddress(), ns3::SatUtils::GetPacketInfo(), ns3::SatEnums::LD_RETURN, ns3::SatEnums::LL_PHY, m_isSending, ns3::SatPhy::m_nodeInfo, ns3::SatPhy::m_packetTrace, ns3::SatPhy::m_phyTx, m_queue, m_queueSizeBytes, m_queueSizeBytesTrace, m_queueSizePackets, m_queueSizePacketsTrace, and ns3::SatEnums::PACKET_SENT.

Referenced by EndTx(), and SendPduWithParams().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendPduWithParams()

void ns3::SatOrbiterFeederPhy::SendPduWithParams ( Ptr< SatSignalParameters > rxParams )

virtual

Send Pdu to the PHY tx module (for satellite switch packet forwarding)

Parameters

rxParams Transmission parameters

In return link, at the satellite, instead of using a constant EIRP (without gain), we are using a fixed amplifier gain amplifying the received signal. With this fixed gain, all bursts in a slot are amplified by the same amplification gain before being transmitted on the feeder link downlink. So, the tx power will be weak for the weak burst, and strong for the strong burst. This approach shall be used for: 1) RTN link only. 2) For all CRDSA, SA, and DA.

Reimplemented from ns3::SatPhy.

Definition at line 262 of file satellite-orbiter-feeder-phy.cc.

References ns3::SatUtils::DbToLinear(), GetE2ESourceAddress(), ns3::SatUtils::GetPacketInfo(), ns3::SatEnums::LD_RETURN, ns3::SatUtils::LinearToDb(), ns3::SatEnums::LL_PHY, ns3::SatPhy::m_eirpWoGainW, m_fixedAmplificationGainDb, m_isSending, ns3::SatPhy::m_nodeInfo, ns3::SatPhy::m_packetTrace, ns3::SatPhy::m_phyTx, m_queue, m_queueSizeBytes, m_queueSizeBytesTrace, m_queueSizeMax, m_queueSizePackets, m_queueSizePacketsTrace, m_returnLinkRegenerationMode, ns3::SatEnums::PACKET_DROP, ns3::SatEnums::PACKET_ENQUE, ns3::SatEnums::PACKET_SENT, ns3::SatEnums::REGENERATION_PHY, SendFromQueue(), ns3::SatPhy::SetTimeTag(), and ns3::SatEnums::TRANSPARENT.