Creates needed objects for UT nodes like SatOrbiterNetDevice objects. More...

#include "satellite-ut-helper.h"

Inheritance diagram for ns3::SatUtHelper:

Collaboration diagram for ns3::SatUtHelper:

Classes
struct	RandomAccessSettings_s
	Define RandomAccessSettings as a struct. More...

Public Member Functions
	SatUtHelper ()
	Default constructor.
	SatUtHelper (SatTypedefs::CarrierBandwidthConverter_t carrierBandwidthConverter, uint32_t rtnLinkCarrierCount, Ptr< SatSuperframeSeq > seq, SatMac::ReadCtrlMsgCallback readCb, SatMac::ReserveCtrlMsgCallback reserveCb, SatMac::SendCtrlMsgCallback sendCb, RandomAccessSettings_s randomAccessSettings)
	Create a SatUtHelper to make life easier when creating Satellite point to point network connections.
virtual	~SatUtHelper ()
	Destructor.
void	EnableCreationTraces (Ptr< OutputStreamWrapper > stream, CallbackBase &cb)
	Enables creation traces to be written in given file.
void	Initialize (Ptr< SatLinkResultsFwd > lrFwd)
NetDeviceContainer	Install (NodeContainer c, uint32_t satId, uint32_t beamId, Ptr< SatChannel > fCh, Ptr< SatChannel > rCh, Ptr< SatNetDevice > gwNd, Ptr< SatNcc > ncc, Address satUserAddress, SatPhy::ChannelPairGetterCallback cbChannel, SatMac::RoutingUpdateCallback cbRouting)
virtual Ptr< NetDevice >	Install (Ptr< Node > n, uint32_t satId, uint32_t beamId, Ptr< SatChannel > fCh, Ptr< SatChannel > rCh, Ptr< SatNetDevice > gwNd, Ptr< SatNcc > ncc, Address satUserAddress, SatPhy::ChannelPairGetterCallback cbChannel, SatMac::RoutingUpdateCallback cbRouting)=0
void	SetChannelAttribute (std::string name, const AttributeValue &value)
	Set an attribute value to be propagated to each Channel created by the helper.
void	SetDeviceAttribute (std::string name, const AttributeValue &value)
	Set an attribute value to be propagated to each NetDevice created by the helper.
void	SetPhyAttribute (std::string name, const AttributeValue &value)
	Set an attribute value to be propagated to each Phy created by the helper.

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

Protected Attributes
bool	m_asyncAccess
SatTypedefs::CarrierBandwidthConverter_t	m_carrierBandwidthConverter
ObjectFactory	m_channelFactory
bool	m_crdsaOnlyForControl
	Planned CRDSA usage:
TracedCallback< std::string >	m_creationTrace
	Trace callback for creation traces.
double	m_daConstantErrorRate
SatPhy::InterferenceModel	m_daInterferenceModel
ObjectFactory	m_deviceFactory
bool	m_enableChannelEstimationError
	Enable channel estimation error modeling at forward link receiver (= UT).
SatPhy::ErrorModel	m_errorModel
uint32_t	m_fwdLinkCarrierCount
Ptr< SatLinkResults >	m_linkResults
Ptr< SatLowerLayerServiceConf >	m_llsConf
	Configured lower layer service configuration.
RandomAccessSettings_s	m_raSettings
	The used random access model settings.
SatMac::ReadCtrlMsgCallback	m_readCtrlCb
SatMac::ReserveCtrlMsgCallback	m_reserveCtrlCb
SatMac::SendCtrlMsgCallback	m_sendCtrlCb
Ptr< SatSuperframeSeq >	m_superframeSeq

Detailed Description

Creates needed objects for UT nodes like SatOrbiterNetDevice objects.

Handles needed configuration for the UT nodes.

Definition at line 52 of file satellite-ut-helper.h.

Constructor & Destructor Documentation

◆ SatUtHelper() [1/2]

ns3::SatUtHelper::SatUtHelper ( )

Default constructor.

Definition at line 110 of file satellite-ut-helper.cc.

References m_asyncAccess, m_carrierBandwidthConverter, m_crdsaOnlyForControl, m_daConstantErrorRate, m_daInterferenceModel, m_enableChannelEstimationError, m_errorModel, m_fwdLinkCarrierCount, m_linkResults, m_llsConf, m_raSettings, and m_superframeSeq.

Referenced by ns3::SatUtHelperDvb::SatUtHelperDvb(), ns3::SatUtHelperLora::SatUtHelperLora(), ns3::SatUtHelperDvb::GetTypeId(), and ns3::SatUtHelperLora::GetTypeId().

Here is the caller graph for this function:

◆ SatUtHelper() [2/2]

ns3::SatUtHelper::SatUtHelper	(	SatTypedefs::CarrierBandwidthConverter_t	carrierBandwidthConverter,
		uint32_t	rtnLinkCarrierCount,
		Ptr< SatSuperframeSeq >	seq,
		SatMac::ReadCtrlMsgCallback	readCb,
		SatMac::ReserveCtrlMsgCallback	reserveCb,
		SatMac::SendCtrlMsgCallback	sendCb,
		RandomAccessSettings_s	randomAccessSettings )

Create a SatUtHelper to make life easier when creating Satellite point to point network connections.

Definition at line 130 of file satellite-ut-helper.cc.

References m_carrierBandwidthConverter, m_channelFactory, m_crdsaOnlyForControl, m_daConstantErrorRate, m_daInterferenceModel, m_deviceFactory, m_enableChannelEstimationError, m_errorModel, m_fwdLinkCarrierCount, m_linkResults, m_llsConf, m_raSettings, m_readCtrlCb, m_reserveCtrlCb, m_sendCtrlCb, and m_superframeSeq.

◆ ~SatUtHelper()

virtual ns3::SatUtHelper::~SatUtHelper ( )

inlinevirtual

Destructor.

Definition at line 91 of file satellite-ut-helper.h.

Member Function Documentation

◆ EnableCreationTraces()

void ns3::SatUtHelper::EnableCreationTraces	(	Ptr< OutputStreamWrapper >	stream,
		CallbackBase &	cb )

Enables creation traces to be written in given file.

Parameters

stream	stream for creation trace outputs
cb	callback to connect traces

Definition at line 222 of file satellite-ut-helper.cc.

◆ GetTypeId()

TypeId ns3::SatUtHelper::GetTypeId ( void )

static

Derived from Object.

Definition at line 49 of file satellite-ut-helper.cc.

References ns3::SatPhyRxCarrierConf::EM_AVI, ns3::SatPhyRxCarrierConf::EM_CONSTANT, ns3::SatPhyRxCarrierConf::EM_NONE, ns3::SatPhyRxCarrierConf::IF_CONSTANT, ns3::SatPhyRxCarrierConf::IF_PER_FRAGMENT, ns3::SatPhyRxCarrierConf::IF_PER_PACKET, ns3::SatPhyRxCarrierConf::IF_TRACE, m_asyncAccess, m_crdsaOnlyForControl, m_creationTrace, m_daConstantErrorRate, m_daInterferenceModel, m_enableChannelEstimationError, m_errorModel, and m_llsConf.

◆ Initialize()

void ns3::SatUtHelper::Initialize ( Ptr< SatLinkResultsFwd > lrFwd )

Definition at line 160 of file satellite-ut-helper.cc.

References ns3::SatPhyRxCarrierConf::EM_AVI, m_errorModel, and m_linkResults.

◆ Install() [1/2]

NetDeviceContainer ns3::SatUtHelper::Install	(	NodeContainer	c,
		uint32_t	satId,
		uint32_t	beamId,
		Ptr< SatChannel >	fCh,
		Ptr< SatChannel >	rCh,
		Ptr< SatNetDevice >	gwNd,
		Ptr< SatNcc >	ncc,
		Address	satUserAddress,
		SatPhy::ChannelPairGetterCallback	cbChannel,
		SatMac::RoutingUpdateCallback	cbRouting )

Parameters

c	a set of nodes
satId	id of the satellite
beamId	id of the beam
fCh	forward channel
rCh	return channel
gwNd	satellite netdevice of the GW
ncc	NCC (Network Control Center)
satUserAddress	MAC address of satellite user link

Returns: Container of installed net devices

This method creates a ns3::SatChannel with the attributes configured by SatUtHelper::SetChannelAttribute, then, for each node in the input container, we create a ns3::SatNetDevice with the requested attributes, a queue for this ns3::NetDevice, and associate the resulting ns3::NetDevice with the ns3::Node and ns3::SatChannel.

Definition at line 197 of file satellite-ut-helper.cc.

References Install().

Referenced by Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Install() [2/2]

virtual Ptr< NetDevice > ns3::SatUtHelper::Install	(	Ptr< Node >	n,
		uint32_t	satId,
		uint32_t	beamId,
		Ptr< SatChannel >	fCh,
		Ptr< SatChannel >	rCh,
		Ptr< SatNetDevice >	gwNd,
		Ptr< SatNcc >	ncc,
		Address	satUserAddress,
		SatPhy::ChannelPairGetterCallback	cbChannel,
		SatMac::RoutingUpdateCallback	cbRouting )

pure virtual

Parameters

n	node
satId	id of the satellite
beamId	id of the beam
fCh	forward channel
rCh	return channel
gwNd	satellite netdevice of the GW
ncc	NCC (Network Control Center)
satUserAddress	MAC address of satellite user link

Returns: Net device installed to node

Saves you from having to construct a temporary NodeContainer. This method is implemented in child classes.

Implemented in ns3::SatUtHelperDvb, and ns3::SatUtHelperLora.

◆ SetChannelAttribute()

void ns3::SatUtHelper::SetChannelAttribute	(	std::string	name,
		const AttributeValue &	value )

Set an attribute value to be propagated to each Channel created by the helper.

Parameters

name	the name of the attribute to set
value	the value of the attribute to set

Set these attribute on each ns3::SatChannel created by SatUtHelper::Install

Definition at line 181 of file satellite-ut-helper.cc.

References m_channelFactory.

◆ SetDeviceAttribute()

void ns3::SatUtHelper::SetDeviceAttribute	(	std::string	name,
		const AttributeValue &	value )

Set an attribute value to be propagated to each NetDevice created by the helper.

Parameters

name	the name of the attribute to set
value	the value of the attribute to set

Set these attributes on each ns3::SatNetDevice created by SatUtHelper::Install

Definition at line 173 of file satellite-ut-helper.cc.

References m_deviceFactory.

◆ SetPhyAttribute()

void ns3::SatUtHelper::SetPhyAttribute	(	std::string	name,
		const AttributeValue &	value )

Set an attribute value to be propagated to each Phy created by the helper.

Parameters

name	the name of the attribute to set
value	the value of the attribute to set

Set these attributes on each ns3::SatNetDevice created by SatUtHelper::Install

Definition at line 189 of file satellite-ut-helper.cc.

Member Data Documentation

◆ m_asyncAccess

bool ns3::SatUtHelper::m_asyncAccess

protected

Definition at line 259 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), and GetTypeId().

◆ m_carrierBandwidthConverter

SatTypedefs::CarrierBandwidthConverter_t ns3::SatUtHelper::m_carrierBandwidthConverter

protected

Definition at line 197 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_channelFactory

ObjectFactory ns3::SatUtHelper::m_channelFactory

protected

Definition at line 206 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), and SetChannelAttribute().

◆ m_crdsaOnlyForControl

bool ns3::SatUtHelper::m_crdsaOnlyForControl

protected

Planned CRDSA usage:

true -> only for control
false -> for control and user data

Definition at line 252 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), GetTypeId(), and ns3::SatUtHelperDvb::Install().

◆ m_creationTrace

TracedCallback<std::string> ns3::SatUtHelper::m_creationTrace

protected

Trace callback for creation traces.

Definition at line 234 of file satellite-ut-helper.h.

Referenced by GetTypeId().

◆ m_daConstantErrorRate

double ns3::SatUtHelper::m_daConstantErrorRate

protected

Definition at line 222 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), GetTypeId(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_daInterferenceModel

SatPhy::InterferenceModel ns3::SatUtHelper::m_daInterferenceModel

protected

Definition at line 212 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), GetTypeId(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_deviceFactory

ObjectFactory ns3::SatUtHelper::m_deviceFactory

protected

Definition at line 207 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), ns3::SatUtHelperDvb::Install(), ns3::SatUtHelperLora::Install(), and SetDeviceAttribute().

◆ m_enableChannelEstimationError

bool ns3::SatUtHelper::m_enableChannelEstimationError

protected

Enable channel estimation error modeling at forward link receiver (= UT).

Definition at line 245 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), GetTypeId(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_errorModel

SatPhy::ErrorModel ns3::SatUtHelper::m_errorModel

protected

Definition at line 217 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), GetTypeId(), Initialize(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_fwdLinkCarrierCount

uint32_t ns3::SatUtHelper::m_fwdLinkCarrierCount

protected

Definition at line 198 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_linkResults

Ptr<SatLinkResults> ns3::SatUtHelper::m_linkResults

protected

Definition at line 229 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), Initialize(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_llsConf

Ptr<SatLowerLayerServiceConf> ns3::SatUtHelper::m_llsConf

protected

Configured lower layer service configuration.

Definition at line 239 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), GetTypeId(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_raSettings

RandomAccessSettings_s ns3::SatUtHelper::m_raSettings

protected

The used random access model settings.

Definition at line 264 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

◆ m_readCtrlCb

SatMac::ReadCtrlMsgCallback ns3::SatUtHelper::m_readCtrlCb

protected

Definition at line 202 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), and ns3::SatUtHelperDvb::Install().

◆ m_reserveCtrlCb

SatMac::ReserveCtrlMsgCallback ns3::SatUtHelper::m_reserveCtrlCb

protected

Definition at line 203 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), and ns3::SatUtHelperDvb::Install().

◆ m_sendCtrlCb

SatMac::SendCtrlMsgCallback ns3::SatUtHelper::m_sendCtrlCb

protected

Definition at line 204 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), and ns3::SatUtHelperDvb::Install().

◆ m_superframeSeq

Ptr<SatSuperframeSeq> ns3::SatUtHelper::m_superframeSeq

protected

Definition at line 199 of file satellite-ut-helper.h.

Referenced by SatUtHelper(), SatUtHelper(), ns3::SatUtHelperDvb::Install(), and ns3::SatUtHelperLora::Install().

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

/builds/sns3/satellite/satellite/helper/satellite-ut-helper.h
/builds/sns3/satellite/satellite/helper/satellite-ut-helper.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SatUtHelper() [1/2]

◆ SatUtHelper() [2/2]

◆ ~SatUtHelper()

Member Function Documentation

◆ EnableCreationTraces()

◆ GetTypeId()

◆ Initialize()

◆ Install() [1/2]

◆ Install() [2/2]

◆ SetChannelAttribute()

◆ SetDeviceAttribute()

◆ SetPhyAttribute()

Member Data Documentation

◆ m_asyncAccess

◆ m_carrierBandwidthConverter

◆ m_channelFactory

◆ m_crdsaOnlyForControl

◆ m_creationTrace

◆ m_daConstantErrorRate

◆ m_daInterferenceModel

◆ m_deviceFactory

◆ m_enableChannelEstimationError

◆ m_errorModel

◆ m_fwdLinkCarrierCount

◆ m_linkResults

◆ m_llsConf

◆ m_raSettings

◆ m_readCtrlCb

◆ m_reserveCtrlCb

◆ m_sendCtrlCb

◆ m_superframeSeq