A configuration class for the satellite reference system. More...

#include "satellite-conf.h"

Inheritance diagram for ns3::SatConf:

Collaboration diagram for ns3::SatConf:

Public Member Functions
	SatConf ()
	Default constructor.
virtual	~SatConf ()
std::vector< uint32_t >	GetBeamConfiguration (uint32_t beamId, SatEnums::SatLinkDir_t dir) const
	Get the configuration vector for a given satellite beam id.
uint32_t	GetBeamCount () const
	Get count of the beams (configurations).
double	GetCarrierBandwidthHz (SatEnums::ChannelType_t chType, uint32_t carrierId, SatEnums::CarrierBandwidthType_t bandwidthType)
	Convert carrier id and sequence id to to bandwidth value.
double	GetCarrierFrequencyHz (SatEnums::ChannelType_t chType, uint32_t freqId, uint32_t carrierId)
	Convert carrier id, sequency id and frequency id to real frequency value.
uint32_t	GetFwdLinkCarrierCount () const
uint32_t	GetGwCount () const
	Get count of the GWs (positions).
GeoCoordinate	GetGwPosition (uint32_t gwId) const
	Get the position of the GW for a given GW id.
uint32_t	GetRtnLinkCarrierCount () const
uint32_t	GetSatCount () const
	Get count of the SATs (positions).
GeoCoordinate	GetSatPosition () const
	Get the position of the Satellite.
std::string	GetStartTimeStr () const
	Get the simulation start time for scenarios using SGP4 model.
Ptr< SatSuperframeSeq >	GetSuperframeSeq ()
uint32_t	GetUtCount () const
	Get count of the UTs (positions).
GeoCoordinate	GetUtPosition (uint32_t utId) const
	Get the position of the GW for a given UT id.
void	Initialize (std::string rtnConf, std::string fwdConf, std::string gwPos, std::string satPos, std::string utPos, std::string wfConf, bool isConstellation=false)
	Initialize the configuration.
std::vector< std::pair< uint32_t, uint32_t > >	LoadIsls (std::string filePathName)
	Load a vector of ISLs from a file.
std::vector< std::vector< uint32_t > >	LoadSatConf (std::string filePathName) const
	Load satellite configuration from a file.
std::vector< std::string >	LoadTles (std::string filePathName, std::string startDatePathName)
	Load a vector of TLE information from a file.
std::ifstream *	OpenFile (std::string filePathName) const
	Try to open a file from a given path.
void	SetUtPositionsPath (std::string inputFileUtListPositions)
	Update the list of positions.

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID.

Static Public Attributes
static const uint32_t	BEAM_ELEM_COUNT = 4
static const uint32_t	BEAM_ID_INDEX = 0
	Definition for beam ID index (column) in m_conf.
static const uint32_t	F_FREQ_ID_INDEX = 3
	Definition for feeder frequency ID index (column) in m_conf.
static const uint32_t	GW_ID_INDEX = 2
	Definition for GW ID index (column) in m_conf.
static const uint32_t	U_FREQ_ID_INDEX = 1
	Definition for user frequency ID index (column) in m_conf.

Private Types
typedef std::vector< GeoCoordinate >	PositionContainer_t

Private Member Functions
void	Configure (std::string wfConf)
	Configures itself with default values.
double	GetFwdLinkCarrierBandwidthHz (uint32_t carrierId, SatEnums::CarrierBandwidthType_t bandwidthType) const
	Get bandwidth of the forward link carrier.
uint32_t	GetGlobalCarrierId (uint32_t seqId, uint32_t carrierId)
double	GetRtnLinkCarrierBandwidthHz (uint32_t carrierId, SatEnums::CarrierBandwidthType_t bandwidthType) const
	Get bandwidth of the return link carrier.
uint32_t	GetSuperframeCarrierId (uint32_t carrierId, uint32_t *seqId)
void	LoadPositions (std::string filePathName, PositionContainer_t &container)
	Load node positions from a file.

Private Attributes
uint32_t	m_beamCount
	Beam count.
std::vector< Ptr< SatFwdCarrierConf > >	m_forwardLinkCarrierConf
	Forward link carrier configuration.
SatEnums::RegenerationMode_t	m_forwardLinkRegenerationMode
	The regeneration mode used in satellites for forward link.
double	m_fwdCarrierAllocatedBandwidthHz
	The configured allocated bandwidth for forward link carriers.
double	m_fwdCarrierRollOffFactor
	The configured carrier roll-off factor for forward link carriers.
double	m_fwdCarrierSpacingFactor
	The configured carrier spacing factor for forward link carriers.
std::vector< std::vector< uint32_t > >	m_fwdConf
double	m_fwdFeederLinkBandwidthHz
	Bandwidth of forward feeder link.
uint32_t	m_fwdFeederLinkChannelCount
double	m_fwdFeederLinkFreqHz
	Base frequency of forward feeder link.
double	m_fwdUserLinkBandwidthHz
	Bandwidth of forward user link.
uint32_t	m_fwdUserLinkChannelCount
	The number of the channels in different satellite links: forward user, return user, forward feeder, return feeder.
double	m_fwdUserLinkFreqHz
	Base frequency of forward user link.
PositionContainer_t	m_gwPositions
	Geodetic positions of the GWs.
bool	m_isConstellation
	Indicates with this is a constellation of satellites.
std::vector< Ptr< SatFwdCarrierConf > >	m_returnLinkCarrierConf
	Return link carrier configuration for SCPC.
SatEnums::RegenerationMode_t	m_returnLinkRegenerationMode
	The regeneration mode used in satellites for return link.
double	m_rtnCarrierAllocatedBandwidthHz
	The configured allocated bandwidth for return link carriers.
double	m_rtnCarrierRollOffFactor
	The configured carrier roll-off factor for return link carriers.
double	m_rtnCarrierSpacingFactor
	The configured carrier spacing factor for return link carriers.
std::vector< std::vector< uint32_t > >	m_rtnConf
double	m_rtnFeederLinkBandwidthHz
	Bandwidth of return feeder link.
uint32_t	m_rtnFeederLinkChannelCount
double	m_rtnFeederLinkFreqHz
	Base frequency of return feeder link.
double	m_rtnUserLinkBandwidthHz
	Bandwidth of return user link.
uint32_t	m_rtnUserLinkChannelCount
double	m_rtnUserLinkFreqHz
	Base frequency of return user link.
PositionContainer_t	m_satPosition
	Geodetic positions of the Satellite.
std::string	m_startTimeStr
	Start time of simulation, on format "YYYY-MM-DD hh:mm:ss".
SatSuperframeConf::SuperFrameConfiguration_t	m_SuperFrameConfForSeq0
	The super frame configuration used for sequence 0.
Ptr< SatSuperframeSeq >	m_superframeSeq
	Superframe sequence configuration.
std::vector< std::string >	m_tles
	TLE information for a satellite constellation.
PositionContainer_t	m_utPositions
	Geodetic positions of the UTs.

Detailed Description

A configuration class for the satellite reference system.

Definition at line 45 of file satellite-conf.h.

Member Typedef Documentation

◆ PositionContainer_t

typedef std::vector<GeoCoordinate> ns3::SatConf::PositionContainer_t

private

Definition at line 245 of file satellite-conf.h.

Constructor & Destructor Documentation

◆ SatConf()

◆ ~SatConf()

virtual ns3::SatConf::~SatConf ( )

inlinevirtual

Definition at line 53 of file satellite-conf.h.

Member Function Documentation

◆ Configure()

void ns3::SatConf::Configure ( std::string wfConf )

private

Configures itself with default values.

Creates configuration storages as needed.

Parameters

wfConf path+filename of the waveform configuration

Definition at line 272 of file satellite-conf.cc.

References ns3::SatSuperframeConf::CreateSuperframeConf(), m_forwardLinkCarrierConf, m_forwardLinkRegenerationMode, m_fwdCarrierAllocatedBandwidthHz, m_fwdCarrierRollOffFactor, m_fwdCarrierSpacingFactor, m_fwdFeederLinkBandwidthHz, m_fwdFeederLinkChannelCount, m_fwdUserLinkBandwidthHz, m_fwdUserLinkChannelCount, m_returnLinkCarrierConf, m_returnLinkRegenerationMode, m_rtnCarrierAllocatedBandwidthHz, m_rtnCarrierRollOffFactor, m_rtnCarrierSpacingFactor, m_rtnFeederLinkBandwidthHz, m_rtnFeederLinkChannelCount, m_rtnUserLinkBandwidthHz, m_rtnUserLinkChannelCount, m_SuperFrameConfForSeq0, m_superframeSeq, ns3::SatEnums::REGENERATION_PHY, and ns3::SatEnums::TRANSPARENT.

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBeamConfiguration()

std::vector< uint32_t > ns3::SatConf::GetBeamConfiguration	(	uint32_t	beamId,
		SatEnums::SatLinkDir_t	dir ) const

Get the configuration vector for a given satellite beam id.

Parameters

beamId id of the beam

Returns: the configuration vector for a given satellite beam id

Definition at line 674 of file satellite-conf.cc.

References ns3::SatEnums::LD_RETURN, m_beamCount, m_fwdConf, and m_rtnConf.

◆ GetBeamCount()

uint32_t ns3::SatConf::GetBeamCount ( ) const

Get count of the beams (configurations).

Returns: beam count

Definition at line 635 of file satellite-conf.cc.

References m_beamCount.

◆ GetCarrierBandwidthHz()

double ns3::SatConf::GetCarrierBandwidthHz	(	SatEnums::ChannelType_t	chType,
		uint32_t	carrierId,
		SatEnums::CarrierBandwidthType_t	bandwidthType )

Convert carrier id and sequence id to to bandwidth value.

Parameters

chType	Type of channel.
carrierId	Id of the carrier.
bandwidthType	Type of the bandwidth.

Returns: bandwidth value

Definition at line 402 of file satellite-conf.cc.

References ns3::SatEnums::FORWARD_FEEDER_CH, ns3::SatEnums::FORWARD_USER_CH, GetFwdLinkCarrierBandwidthHz(), GetRtnLinkCarrierBandwidthHz(), m_returnLinkRegenerationMode, m_superframeSeq, ns3::SatEnums::REGENERATION_LINK, ns3::SatEnums::REGENERATION_NETWORK, ns3::SatEnums::RETURN_FEEDER_CH, and ns3::SatEnums::RETURN_USER_CH.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCarrierFrequencyHz()

double ns3::SatConf::GetCarrierFrequencyHz	(	SatEnums::ChannelType_t	chType,
		uint32_t	freqId,
		uint32_t	carrierId )

Convert carrier id, sequency id and frequency id to real frequency value.

Parameters

chType	Type of channel.
freqId	Id of the frequency.
carrierId	Id of the carrier.

Returns: real frequency value

Definition at line 344 of file satellite-conf.cc.

References ns3::SatEnums::FORWARD_FEEDER_CH, ns3::SatEnums::FORWARD_USER_CH, m_forwardLinkCarrierConf, m_fwdFeederLinkBandwidthHz, m_fwdFeederLinkChannelCount, m_fwdFeederLinkFreqHz, m_fwdUserLinkBandwidthHz, m_fwdUserLinkChannelCount, m_fwdUserLinkFreqHz, m_rtnFeederLinkBandwidthHz, m_rtnFeederLinkChannelCount, m_rtnFeederLinkFreqHz, m_rtnUserLinkBandwidthHz, m_rtnUserLinkChannelCount, m_rtnUserLinkFreqHz, m_superframeSeq, ns3::SatEnums::RETURN_FEEDER_CH, and ns3::SatEnums::RETURN_USER_CH.

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

Here is the caller graph for this function:

◆ GetFwdLinkCarrierBandwidthHz()

double ns3::SatConf::GetFwdLinkCarrierBandwidthHz	(	uint32_t	carrierId,
		SatEnums::CarrierBandwidthType_t	bandwidthType ) const

private

Get bandwidth of the forward link carrier.

Parameters

carrierId	Id of the carrier.
bandwidthType	Type of the bandwidth.

Returns: Requested carrier bandwidth.

Definition at line 699 of file satellite-conf.cc.

References ns3::SatEnums::ALLOCATED_BANDWIDTH, ns3::SatEnums::EFFECTIVE_BANDWIDTH, m_forwardLinkCarrierConf, and ns3::SatEnums::OCCUPIED_BANDWIDTH.

Referenced by GetCarrierBandwidthHz().

Here is the caller graph for this function:

◆ GetFwdLinkCarrierCount()

uint32_t ns3::SatConf::GetFwdLinkCarrierCount ( ) const

Returns: The number of the carriers in return link.

Definition at line 691 of file satellite-conf.cc.

References m_forwardLinkCarrierConf.

◆ GetGlobalCarrierId()

uint32_t ns3::SatConf::GetGlobalCarrierId	(	uint32_t	seqId,
		uint32_t	carrierId )

private

Parameters

seqId	Sequence of the superframe.
carrierId	Carrier ID inside requested superframe.

Returns: Global carrier id across all superframe sequences.

◆ GetGwCount()

uint32_t ns3::SatConf::GetGwCount ( ) const

Get count of the GWs (positions).

Returns: GW count

Definition at line 643 of file satellite-conf.cc.

References m_gwPositions.

◆ GetGwPosition()

GeoCoordinate ns3::SatConf::GetGwPosition ( uint32_t gwId ) const

Get the position of the GW for a given GW id.

Parameters

gwId	id of the GW

Returns: Requested GW's position.

Definition at line 769 of file satellite-conf.cc.

References m_gwPositions.

◆ GetRtnLinkCarrierBandwidthHz()

double ns3::SatConf::GetRtnLinkCarrierBandwidthHz	(	uint32_t	carrierId,
		SatEnums::CarrierBandwidthType_t	bandwidthType ) const

private

Get bandwidth of the return link carrier.

Parameters

carrierId	Id of the carrier.
bandwidthType	Type of the bandwidth.

Returns: Requested carrier bandwidth.

Definition at line 734 of file satellite-conf.cc.

References ns3::SatEnums::ALLOCATED_BANDWIDTH, ns3::SatEnums::EFFECTIVE_BANDWIDTH, m_returnLinkCarrierConf, and ns3::SatEnums::OCCUPIED_BANDWIDTH.

Referenced by GetCarrierBandwidthHz().

Here is the caller graph for this function:

◆ GetRtnLinkCarrierCount()

uint32_t ns3::SatConf::GetRtnLinkCarrierCount ( ) const

Returns: The number of the carriers in return link.

Definition at line 683 of file satellite-conf.cc.

References m_superframeSeq.

◆ GetSatCount()

uint32_t ns3::SatConf::GetSatCount ( ) const

Get count of the SATs (positions).

Returns: SAT count

Definition at line 659 of file satellite-conf.cc.

References m_isConstellation, m_satPosition, and m_tles.

◆ GetSatPosition()

GeoCoordinate ns3::SatConf::GetSatPosition ( ) const

Get the position of the Satellite.

Returns: satellite position.

Definition at line 787 of file satellite-conf.cc.

References m_satPosition.

◆ GetStartTimeStr()

std::string ns3::SatConf::GetStartTimeStr ( ) const

Get the simulation start time for scenarios using SGP4 model.

Returns: String representation of start time, using format "YYYY-MM-DD hh:mm:ss"

Definition at line 796 of file satellite-conf.cc.

References m_startTimeStr.

◆ GetSuperframeCarrierId()

uint32_t ns3::SatConf::GetSuperframeCarrierId	(	uint32_t	carrierId,
		uint32_t *	seqId )

private

Parameters

carrierId	Global carrier ID across all superframe sequences.
seqId	Pointer to variable to store seqId of the super frame sequence where global id belongs to

Returns: Carrier id relative to the superframe

◆ GetSuperframeSeq()

Ptr< SatSuperframeSeq > ns3::SatConf::GetSuperframeSeq ( )

inline

Definition at line 63 of file satellite-conf.h.

References m_superframeSeq.

◆ GetTypeId()

TypeId ns3::SatConf::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 48 of file satellite-conf.cc.

References m_forwardLinkRegenerationMode, m_fwdCarrierAllocatedBandwidthHz, m_fwdCarrierRollOffFactor, m_fwdCarrierSpacingFactor, m_fwdFeederLinkBandwidthHz, m_fwdFeederLinkChannelCount, m_fwdFeederLinkFreqHz, m_fwdUserLinkBandwidthHz, m_fwdUserLinkChannelCount, m_fwdUserLinkFreqHz, m_returnLinkRegenerationMode, m_rtnCarrierAllocatedBandwidthHz, m_rtnCarrierRollOffFactor, m_rtnCarrierSpacingFactor, m_rtnFeederLinkBandwidthHz, m_rtnFeederLinkChannelCount, m_rtnFeederLinkFreqHz, m_rtnUserLinkBandwidthHz, m_rtnUserLinkChannelCount, m_rtnUserLinkFreqHz, m_SuperFrameConfForSeq0, ns3::SatEnums::REGENERATION_LINK, ns3::SatEnums::REGENERATION_NETWORK, ns3::SatEnums::REGENERATION_PHY, ns3::SatSuperframeConf::SUPER_FRAME_CONFIG_0, ns3::SatSuperframeConf::SUPER_FRAME_CONFIG_1, ns3::SatSuperframeConf::SUPER_FRAME_CONFIG_2, ns3::SatSuperframeConf::SUPER_FRAME_CONFIG_3, ns3::SatSuperframeConf::SUPER_FRAME_CONFIG_4, and ns3::SatEnums::TRANSPARENT.

◆ GetUtCount()

uint32_t ns3::SatConf::GetUtCount ( ) const

Get count of the UTs (positions).

Returns: UT count

Definition at line 651 of file satellite-conf.cc.

References m_utPositions.

◆ GetUtPosition()

GeoCoordinate ns3::SatConf::GetUtPosition ( uint32_t utId ) const

Get the position of the GW for a given UT id.

Parameters

utId	id of the UT (from SatIdMapper)

Returns: Requested UT's position.

Definition at line 778 of file satellite-conf.cc.

References m_utPositions.

◆ Initialize()

void ns3::SatConf::Initialize	(	std::string	rtnConf,
		std::string	fwdConf,
		std::string	gwPos,
		std::string	satPos,
		std::string	utPos,
		std::string	wfConf,
		bool	isConstellation = false )

Initialize the configuration.

Parameters

rtnConf	RTN link configuration file name
fwdConf	FWD link configuration file name
gwPos	GW position file name
satPos	Satellite position file name
satPos	UT position file name
wfConf	Waveform configuration file name
isConstellation	Indicates if SatConf describes a constellation

Definition at line 218 of file satellite-conf.cc.

References Configure(), GW_ID_INDEX, LoadPositions(), LoadSatConf(), m_beamCount, m_forwardLinkRegenerationMode, m_fwdConf, m_gwPositions, m_isConstellation, m_returnLinkRegenerationMode, m_rtnConf, m_satPosition, m_utPositions, and ns3::SatConstVariables::MAX_BEAMS_PER_SATELLITE.

Here is the call graph for this function:

◆ LoadIsls()

std::vector< std::pair< uint32_t, uint32_t > > ns3::SatConf::LoadIsls ( std::string filePathName )

Load a vector of ISLs from a file.

Parameters

filePathName

Returns: ISLs information extracted from file. This corresponds to satellite pairs linked by ISLs

Definition at line 593 of file satellite-conf.cc.

References OpenFile().

Here is the call graph for this function:

◆ LoadPositions()

void ns3::SatConf::LoadPositions	(	std::string	filePathName,
		PositionContainer_t &	container )

private

Load node positions from a file.

Parameters

filePathName
container	Container reference to store found positions

Definition at line 512 of file satellite-conf.cc.

References OpenFile().

Referenced by Initialize(), and SetUtPositionsPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadSatConf()

std::vector< std::vector< uint32_t > > ns3::SatConf::LoadSatConf ( std::string filePathName ) const

Load satellite configuration from a file.

Parameters

filePathName

Returns: Container of the configuration data

Definition at line 465 of file satellite-conf.cc.

References OpenFile().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadTles()

std::vector< std::string > ns3::SatConf::LoadTles	(	std::string	filePathName,
		std::string	startDatePathName )

Load a vector of TLE information from a file.

Parameters

filePathName	Path to the file containing the TLEs
startDatePathName	Path to the file containing the simulation start date

Returns: TLE information extracted from file

Definition at line 540 of file satellite-conf.cc.

References m_startTimeStr, m_tles, ns3::SatConstVariables::MAX_SATELLITES, and OpenFile().

Here is the call graph for this function:

◆ OpenFile()

std::ifstream * ns3::SatConf::OpenFile ( std::string filePathName ) const

Try to open a file from a given path.

Parameters

filePathName

Definition at line 442 of file satellite-conf.cc.

Referenced by LoadIsls(), LoadPositions(), LoadSatConf(), and LoadTles().

Here is the caller graph for this function:

◆ SetUtPositionsPath()

void ns3::SatConf::SetUtPositionsPath ( std::string inputFileUtListPositions )

Update the list of positions.

Parameters

Path	of the new file to load

Definition at line 503 of file satellite-conf.cc.

References LoadPositions(), and m_utPositions.

Here is the call graph for this function:

Member Data Documentation

◆ BEAM_ELEM_COUNT

const uint32_t ns3::SatConf::BEAM_ELEM_COUNT = 4

static

Definition at line 242 of file satellite-conf.h.

◆ BEAM_ID_INDEX

const uint32_t ns3::SatConf::BEAM_ID_INDEX = 0

static

Definition for beam ID index (column) in m_conf.

Definition at line 226 of file satellite-conf.h.

Referenced by ns3::SatHelper::DoCreateScenario().

◆ F_FREQ_ID_INDEX

const uint32_t ns3::SatConf::F_FREQ_ID_INDEX = 3

static

Definition for feeder frequency ID index (column) in m_conf.

Definition at line 241 of file satellite-conf.h.

Referenced by ns3::SatHelper::DoCreateScenario().

◆ GW_ID_INDEX

const uint32_t ns3::SatConf::GW_ID_INDEX = 2

static

Definition for GW ID index (column) in m_conf.

Definition at line 236 of file satellite-conf.h.

Referenced by ns3::SatHelper::DoCreateScenario(), and Initialize().

◆ m_beamCount

uint32_t ns3::SatConf::m_beamCount

private

Beam count.

Definition at line 265 of file satellite-conf.h.

Referenced by SatConf(), GetBeamConfiguration(), GetBeamCount(), and Initialize().

◆ m_forwardLinkCarrierConf

std::vector<Ptr<SatFwdCarrierConf> > ns3::SatConf::m_forwardLinkCarrierConf

private

Forward link carrier configuration.

Item index of the list means carrier configuration sequence. Currently only one sequence used and only one carrier inside carrier conf.

Definition at line 306 of file satellite-conf.h.

Referenced by Configure(), GetCarrierFrequencyHz(), GetFwdLinkCarrierBandwidthHz(), and GetFwdLinkCarrierCount().

◆ m_forwardLinkRegenerationMode

SatEnums::RegenerationMode_t ns3::SatConf::m_forwardLinkRegenerationMode

private

The regeneration mode used in satellites for forward link.

Definition at line 404 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetTypeId(), and Initialize().

◆ m_fwdCarrierAllocatedBandwidthHz

double ns3::SatConf::m_fwdCarrierAllocatedBandwidthHz

private

The configured allocated bandwidth for forward link carriers.

Definition at line 374 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_fwdCarrierRollOffFactor

double ns3::SatConf::m_fwdCarrierRollOffFactor

private

The configured carrier roll-off factor for forward link carriers.

Definition at line 379 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_fwdCarrierSpacingFactor

double ns3::SatConf::m_fwdCarrierSpacingFactor

private

The configured carrier spacing factor for forward link carriers.

Definition at line 384 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_fwdConf

std::vector<std::vector<uint32_t> > ns3::SatConf::m_fwdConf

private

Definition at line 255 of file satellite-conf.h.

Referenced by GetBeamConfiguration(), and Initialize().

◆ m_fwdFeederLinkBandwidthHz

double ns3::SatConf::m_fwdFeederLinkBandwidthHz

private

Bandwidth of forward feeder link.

Definition at line 324 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_fwdFeederLinkChannelCount

uint32_t ns3::SatConf::m_fwdFeederLinkChannelCount

private

Definition at line 363 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_fwdFeederLinkFreqHz

double ns3::SatConf::m_fwdFeederLinkFreqHz

private

Base frequency of forward feeder link.

Definition at line 319 of file satellite-conf.h.

Referenced by SatConf(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_fwdUserLinkBandwidthHz

double ns3::SatConf::m_fwdUserLinkBandwidthHz

private

Bandwidth of forward user link.

Definition at line 334 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_fwdUserLinkChannelCount

uint32_t ns3::SatConf::m_fwdUserLinkChannelCount

private

The number of the channels in different satellite links: forward user, return user, forward feeder, return feeder.

Definition at line 361 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_fwdUserLinkFreqHz

double ns3::SatConf::m_fwdUserLinkFreqHz

private

Base frequency of forward user link.

Definition at line 329 of file satellite-conf.h.

Referenced by SatConf(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_gwPositions

PositionContainer_t ns3::SatConf::m_gwPositions

private

Geodetic positions of the GWs.

Definition at line 270 of file satellite-conf.h.

Referenced by GetGwCount(), GetGwPosition(), and Initialize().

◆ m_isConstellation

bool ns3::SatConf::m_isConstellation

private

Indicates with this is a constellation of satellites.

Definition at line 260 of file satellite-conf.h.

Referenced by GetSatCount(), and Initialize().

◆ m_returnLinkCarrierConf

std::vector<Ptr<SatFwdCarrierConf> > ns3::SatConf::m_returnLinkCarrierConf

private

Return link carrier configuration for SCPC.

Item index of the list means carrier configuration sequence. Currently only one sequence used and only one carrier inside carrier conf.

Definition at line 314 of file satellite-conf.h.

Referenced by Configure(), and GetRtnLinkCarrierBandwidthHz().

◆ m_returnLinkRegenerationMode

SatEnums::RegenerationMode_t ns3::SatConf::m_returnLinkRegenerationMode

private

The regeneration mode used in satellites for return link.

Definition at line 409 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierBandwidthHz(), GetTypeId(), and Initialize().

◆ m_rtnCarrierAllocatedBandwidthHz

double ns3::SatConf::m_rtnCarrierAllocatedBandwidthHz

private

The configured allocated bandwidth for return link carriers.

Definition at line 389 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_rtnCarrierRollOffFactor

double ns3::SatConf::m_rtnCarrierRollOffFactor

private

The configured carrier roll-off factor for return link carriers.

Definition at line 394 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_rtnCarrierSpacingFactor

double ns3::SatConf::m_rtnCarrierSpacingFactor

private

The configured carrier spacing factor for return link carriers.

Definition at line 399 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_rtnConf

std::vector<std::vector<uint32_t> > ns3::SatConf::m_rtnConf

private

Definition at line 254 of file satellite-conf.h.

Referenced by GetBeamConfiguration(), and Initialize().

◆ m_rtnFeederLinkBandwidthHz

double ns3::SatConf::m_rtnFeederLinkBandwidthHz

private

Bandwidth of return feeder link.

Definition at line 344 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_rtnFeederLinkChannelCount

uint32_t ns3::SatConf::m_rtnFeederLinkChannelCount

private

Definition at line 364 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_rtnFeederLinkFreqHz

double ns3::SatConf::m_rtnFeederLinkFreqHz

private

Base frequency of return feeder link.

Definition at line 339 of file satellite-conf.h.

Referenced by SatConf(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_rtnUserLinkBandwidthHz

double ns3::SatConf::m_rtnUserLinkBandwidthHz

private

Bandwidth of return user link.

Definition at line 354 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_rtnUserLinkChannelCount

uint32_t ns3::SatConf::m_rtnUserLinkChannelCount

private

Definition at line 362 of file satellite-conf.h.

Referenced by SatConf(), Configure(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_rtnUserLinkFreqHz

double ns3::SatConf::m_rtnUserLinkFreqHz

private

Base frequency of return user link.

Definition at line 349 of file satellite-conf.h.

Referenced by SatConf(), GetCarrierFrequencyHz(), and GetTypeId().

◆ m_satPosition

PositionContainer_t ns3::SatConf::m_satPosition

private

Geodetic positions of the Satellite.

Definition at line 280 of file satellite-conf.h.

Referenced by GetSatCount(), GetSatPosition(), and Initialize().

◆ m_startTimeStr

std::string ns3::SatConf::m_startTimeStr

private

Start time of simulation, on format "YYYY-MM-DD hh:mm:ss".

Definition at line 290 of file satellite-conf.h.

Referenced by GetStartTimeStr(), and LoadTles().

◆ m_SuperFrameConfForSeq0

SatSuperframeConf::SuperFrameConfiguration_t ns3::SatConf::m_SuperFrameConfForSeq0

private

The super frame configuration used for sequence 0.

Definition at line 369 of file satellite-conf.h.

Referenced by SatConf(), Configure(), and GetTypeId().

◆ m_superframeSeq

Ptr<SatSuperframeSeq> ns3::SatConf::m_superframeSeq

private

Superframe sequence configuration.

Table includes superframe configurations for return link. Item index of the list means superframe sequency (SFS).

Definition at line 298 of file satellite-conf.h.

Referenced by Configure(), GetCarrierBandwidthHz(), GetCarrierFrequencyHz(), GetRtnLinkCarrierCount(), and GetSuperframeSeq().

◆ m_tles

std::vector<std::string> ns3::SatConf::m_tles

private

TLE information for a satellite constellation.

Definition at line 285 of file satellite-conf.h.

Referenced by GetSatCount(), and LoadTles().

◆ m_utPositions

PositionContainer_t ns3::SatConf::m_utPositions

private

Geodetic positions of the UTs.

Definition at line 275 of file satellite-conf.h.

Referenced by GetUtCount(), GetUtPosition(), Initialize(), and SetUtPositionsPath().

◆ U_FREQ_ID_INDEX

const uint32_t ns3::SatConf::U_FREQ_ID_INDEX = 1

static

Definition for user frequency ID index (column) in m_conf.

Definition at line 231 of file satellite-conf.h.

Referenced by ns3::SatHelper::DoCreateScenario().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PositionContainer_t

Constructor & Destructor Documentation

◆ SatConf()

◆ ~SatConf()

Member Function Documentation

◆ Configure()

◆ GetBeamConfiguration()

◆ GetBeamCount()

◆ GetCarrierBandwidthHz()

◆ GetCarrierFrequencyHz()

◆ GetFwdLinkCarrierBandwidthHz()

◆ GetFwdLinkCarrierCount()

◆ GetGlobalCarrierId()

◆ GetGwCount()

◆ GetGwPosition()

◆ GetRtnLinkCarrierBandwidthHz()

◆ GetRtnLinkCarrierCount()

◆ GetSatCount()

◆ GetSatPosition()

◆ GetStartTimeStr()

◆ GetSuperframeCarrierId()

◆ GetSuperframeSeq()

◆ GetTypeId()

◆ GetUtCount()

◆ GetUtPosition()

◆ Initialize()

◆ LoadIsls()

◆ LoadPositions()

◆ LoadSatConf()

◆ LoadTles()

◆ OpenFile()

◆ SetUtPositionsPath()

Member Data Documentation

◆ BEAM_ELEM_COUNT

◆ BEAM_ID_INDEX

◆ F_FREQ_ID_INDEX

◆ GW_ID_INDEX

◆ m_beamCount

◆ m_forwardLinkCarrierConf

◆ m_forwardLinkRegenerationMode

◆ m_fwdCarrierAllocatedBandwidthHz

◆ m_fwdCarrierRollOffFactor

◆ m_fwdCarrierSpacingFactor

◆ m_fwdConf

◆ m_fwdFeederLinkBandwidthHz

◆ m_fwdFeederLinkChannelCount

◆ m_fwdFeederLinkFreqHz

◆ m_fwdUserLinkBandwidthHz

◆ m_fwdUserLinkChannelCount

◆ m_fwdUserLinkFreqHz

◆ m_gwPositions

◆ m_isConstellation

◆ m_returnLinkCarrierConf

◆ m_returnLinkRegenerationMode

◆ m_rtnCarrierAllocatedBandwidthHz

◆ m_rtnCarrierRollOffFactor

◆ m_rtnCarrierSpacingFactor

◆ m_rtnConf

◆ m_rtnFeederLinkBandwidthHz

◆ m_rtnFeederLinkChannelCount

◆ m_rtnFeederLinkFreqHz

◆ m_rtnUserLinkBandwidthHz

◆ m_rtnUserLinkChannelCount

◆ m_rtnUserLinkFreqHz

◆ m_satPosition

◆ m_startTimeStr

◆ m_SuperFrameConfForSeq0

◆ m_superframeSeq

◆ m_tles

◆ m_utPositions

◆ U_FREQ_ID_INDEX