Container class for external input fading traces. More...

#include "satellite-fading-external-input-trace-container.h"

Inheritance diagram for ns3::SatFadingExternalInputTraceContainer:

Collaboration diagram for ns3::SatFadingExternalInputTraceContainer:

Public Types
typedef std::pair< Ptr< SatFadingExternalInputTrace >, Ptr< SatFadingExternalInputTrace > >	ChannelTracePair_t
	Define type ChannelTracePair_t.
enum	InputMode_t { LIST_MODE , POSITION_MODE , RANDOM_MODE }
	Definitions for different modes of using trace input files. More...

Public Member Functions
	SatFadingExternalInputTraceContainer ()
	Constructor.
	~SatFadingExternalInputTraceContainer ()
	Destructor.
Ptr< SatFadingExternalInputTrace >	GetFadingTrace (uint32_t nodeId, SatEnums::ChannelType_t channelType, Ptr< MobilityModel > mobility)
	Get method for getting a proper fading trace.
virtual void	NotifyConstructionCompleted () override
	Notifier called once the ObjectBase is fully constructed.
bool	TestFadingTraces (uint32_t numOfUts, uint32_t numOfGws)
	A method to test that the fading traces are according to assumptions.

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

Private Types
typedef std::vector< TraceFileContainerItem_t >	TraceFileContainer_t
typedef std::pair< std::string, GeoCoordinate >	TraceFileContainerItem_t
typedef std::map< std::string, Ptr< SatFadingExternalInputTrace > >	TraceInputContainer_t

Private Member Functions
Ptr< SatFadingExternalInputTrace >	CreateFadingTrace (SatFadingExternalInputTrace::TraceFileType_e fileType, InputMode_t inputMode, TraceFileContainer_t &container, uint32_t id, Ptr< MobilityModel > mobility)
	Create (or load) fading trace source for the requested UT/GW.
void	CreateGwFadingTrace (uint32_t gwId, Ptr< MobilityModel > mobility)
	Create new GW fading trace.
void	CreateUtFadingTrace (uint32_t utId, Ptr< MobilityModel > mobility)
	Create new UT fading trace.
std::string	FindSourceBasedOnPosition (TraceFileContainer_t &container, uint32_t id, Ptr< MobilityModel > mobility)
	Find the nearest fading trace source file for the requested UT/GW based on given mobility.
void	LoadIndexFiles ()
	Initialize index files.
void	ReadIndexFile (std::string indexFile, TraceFileContainer_t &container)
	Read trace file information from given index file.

Private Attributes
std::string	m_dataPath
	data path to find trace input files
std::map< uint32_t, ChannelTracePair_t >	m_gwFadingMap
	Container of the GW fading traces.
TraceFileContainer_t	m_gwFwdUpFileNames
	GW forward up link trace file names.
std::string	m_gwFwdUpIndexFileName
	The name of file which defines the index table to be used for trace input of forward up link for GWs.
TraceFileContainer_t	m_gwRtnDownFileNames
	GW return down link trace file names.
std::string	m_gwRtnDownIndexFileName
	The name of file which defines the index table to be used for trace input of forward up link for GWs.
bool	m_indexFilesLoaded
	flag telling if index trace files are already loaded
TraceInputContainer_t	m_loadedTraces
	Loaded trace files.
double	m_maxDistanceToFading
	Maximum distance allowed to the external fading trace source.
std::map< uint32_t, ChannelTracePair_t >	m_utFadingMap
	Container of the UT fading traces.
TraceFileContainer_t	m_utFwdDownFileNames
	UT forward down link trace file names.
std::string	m_utFwdDownIndexFileName
	The name of file which defines the index table to be used for trace input of forward down link for UT.
InputMode_t	m_utInputMode
	Input mode to read trace files form given index table (file) for UTs.
TraceFileContainer_t	m_utRtnUpFileNames
	UT return up link trace file names.
std::string	m_utRtnUpIndexFileName
	The name of file which defines the index table to be used for trace input of return up link for UTs.

Detailed Description

Container class for external input fading traces.

The class provides an interface for accessing the correct fading trace object.

Definition at line 45 of file satellite-fading-external-input-trace-container.h.

Member Typedef Documentation

◆ ChannelTracePair_t

typedef std::pair<Ptr<SatFadingExternalInputTrace>, Ptr<SatFadingExternalInputTrace> > ns3::SatFadingExternalInputTraceContainer::ChannelTracePair_t

Define type ChannelTracePair_t.

Definition at line 62 of file satellite-fading-external-input-trace-container.h.

◆ TraceFileContainer_t

typedef std::vector<TraceFileContainerItem_t> ns3::SatFadingExternalInputTraceContainer::TraceFileContainer_t

private

Definition at line 113 of file satellite-fading-external-input-trace-container.h.

◆ TraceFileContainerItem_t

typedef std::pair<std::string, GeoCoordinate> ns3::SatFadingExternalInputTraceContainer::TraceFileContainerItem_t

private

Definition at line 112 of file satellite-fading-external-input-trace-container.h.

◆ TraceInputContainer_t

typedef std::map<std::string, Ptr<SatFadingExternalInputTrace> > ns3::SatFadingExternalInputTraceContainer::TraceInputContainer_t

private

Definition at line 115 of file satellite-fading-external-input-trace-container.h.

Member Enumeration Documentation

◆ InputMode_t

enum ns3::SatFadingExternalInputTraceContainer::InputMode_t

Definitions for different modes of using trace input files.

Enumerator
LIST_MODE	LIST_MODE.
POSITION_MODE	POSITION_MODE.
RANDOM_MODE	RANDOM_MODE.

Definition at line 51 of file satellite-fading-external-input-trace-container.h.

Constructor & Destructor Documentation

◆ SatFadingExternalInputTraceContainer()

ns3::SatFadingExternalInputTraceContainer::SatFadingExternalInputTraceContainer ( )

Constructor.

Definition at line 97 of file satellite-fading-external-input-trace-container.cc.

References LIST_MODE, m_indexFilesLoaded, m_maxDistanceToFading, and m_utInputMode.

◆ ~SatFadingExternalInputTraceContainer()

ns3::SatFadingExternalInputTraceContainer::~SatFadingExternalInputTraceContainer ( )

Destructor.

Definition at line 116 of file satellite-fading-external-input-trace-container.cc.

References m_gwFadingMap, and m_utFadingMap.

Member Function Documentation

◆ CreateFadingTrace()

Ptr< SatFadingExternalInputTrace > ns3::SatFadingExternalInputTraceContainer::CreateFadingTrace	(	SatFadingExternalInputTrace::TraceFileType_e	fileType,
		InputMode_t	inputMode,
		TraceFileContainer_t &	container,
		uint32_t	id,
		Ptr< MobilityModel >	mobility )

private

Create (or load) fading trace source for the requested UT/GW.

Parameters

fileType	Type of the trace file
inputMode	used when reading input traces from trace file
container	Container reference to find out needed trace file info
id	Id of the node GW or UT (from SatIdMapper)
mobility	Mobility for given node

Returns: Created trace input (or found trace input if queried trace input already created)

Definition at line 377 of file satellite-fading-external-input-trace-container.cc.

References FindSourceBasedOnPosition(), LIST_MODE, m_dataPath, m_loadedTraces, m_utInputMode, POSITION_MODE, and RANDOM_MODE.

Referenced by CreateGwFadingTrace(), and CreateUtFadingTrace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateGwFadingTrace()

void ns3::SatFadingExternalInputTraceContainer::CreateGwFadingTrace	(	uint32_t	gwId,
		Ptr< MobilityModel >	mobility )

private

Create new GW fading trace.

Parameters

gwId	Id of the GW (from SatIdMapper)
mobility	Mobility for given GW node

Definition at line 170 of file satellite-fading-external-input-trace-container.cc.

References CreateFadingTrace(), ns3::SatFadingExternalInputTrace::FT_TWO_COLUMN, LIST_MODE, LoadIndexFiles(), m_gwFadingMap, m_gwFwdUpFileNames, m_gwRtnDownFileNames, and m_indexFilesLoaded.

Referenced by GetFadingTrace(), and TestFadingTraces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateUtFadingTrace()

void ns3::SatFadingExternalInputTraceContainer::CreateUtFadingTrace	(	uint32_t	utId,
		Ptr< MobilityModel >	mobility )

private

Create new UT fading trace.

Parameters

utId	Id of the UT (from SatIdMapper)
mobility	Mobility for given UT node

Definition at line 141 of file satellite-fading-external-input-trace-container.cc.

References CreateFadingTrace(), ns3::SatFadingExternalInputTrace::FT_THREE_COLUMN, ns3::SatFadingExternalInputTrace::FT_TWO_COLUMN, LoadIndexFiles(), m_indexFilesLoaded, m_utFadingMap, m_utFwdDownFileNames, m_utInputMode, and m_utRtnUpFileNames.

Referenced by GetFadingTrace(), and TestFadingTraces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindSourceBasedOnPosition()

std::string ns3::SatFadingExternalInputTraceContainer::FindSourceBasedOnPosition	(	TraceFileContainer_t &	container,
		uint32_t	id,
		Ptr< MobilityModel >	mobility )

private

Find the nearest fading trace source file for the requested UT/GW based on given mobility.

Only external fading sources which are closer than (equal to) maximum allowed distance are accepted. Maximum allowed distance is defined by attribute.

Parameters

container	Container reference to find out needed trace file info
id	Id of the node GW or UT (from SatIdMapper)
mobility	Mobility for given node

Returns: The name of the nearest external fading source.

Definition at line 443 of file satellite-fading-external-input-trace-container.cc.

References m_maxDistanceToFading.

Referenced by CreateFadingTrace().

Here is the caller graph for this function:

◆ GetFadingTrace()

Ptr< SatFadingExternalInputTrace > ns3::SatFadingExternalInputTraceContainer::GetFadingTrace	(	uint32_t	nodeId,
		SatEnums::ChannelType_t	channelType,
		Ptr< MobilityModel >	mobility )

Get method for getting a proper fading trace.

Parameters

nodeId	GW or UT Node id (from SatIdMapper)
channelType	Channel type
mobility	Mobility of the node

Returns: Channel fading trace for a certain node and channel.

Definition at line 199 of file satellite-fading-external-input-trace-container.cc.

References CreateGwFadingTrace(), CreateUtFadingTrace(), ns3::SatEnums::FORWARD_FEEDER_CH, ns3::SatEnums::FORWARD_USER_CH, m_gwFadingMap, m_utFadingMap, ns3::SatEnums::RETURN_FEEDER_CH, and ns3::SatEnums::RETURN_USER_CH.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::SatFadingExternalInputTraceContainer::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 47 of file satellite-fading-external-input-trace-container.cc.

References LIST_MODE, m_gwFwdUpIndexFileName, m_gwRtnDownIndexFileName, m_maxDistanceToFading, m_utFwdDownIndexFileName, m_utInputMode, m_utRtnUpIndexFileName, POSITION_MODE, and RANDOM_MODE.

◆ LoadIndexFiles()

void ns3::SatFadingExternalInputTraceContainer::LoadIndexFiles ( )

private

Initialize index files.

Definition at line 125 of file satellite-fading-external-input-trace-container.cc.

References m_gwFwdUpFileNames, m_gwFwdUpIndexFileName, m_gwRtnDownFileNames, m_gwRtnDownIndexFileName, m_indexFilesLoaded, m_utFwdDownFileNames, m_utFwdDownIndexFileName, m_utRtnUpFileNames, m_utRtnUpIndexFileName, and ReadIndexFile().

Referenced by CreateGwFadingTrace(), and CreateUtFadingTrace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NotifyConstructionCompleted()

void ns3::SatFadingExternalInputTraceContainer::NotifyConstructionCompleted ( )

overridevirtual

Notifier called once the ObjectBase is fully constructed.

This method is invoked once all member attributes have been initialized. Subclasses can override this method to be notified of this event but if they do this, they must chain up to their parent's NotifyConstructionCompleted method.

Definition at line 106 of file satellite-fading-external-input-trace-container.cc.

References ns3::SatEnvVariables::GetInstance(), and m_dataPath.

Here is the call graph for this function:

◆ ReadIndexFile()

void ns3::SatFadingExternalInputTraceContainer::ReadIndexFile	(	std::string	indexFile,
		TraceFileContainer_t &	container )

private

Read trace file information from given index file.

Parameters

indexFile	Index file to parse for trace file names
container	Container reference to store found trace file info

Definition at line 337 of file satellite-fading-external-input-trace-container.cc.

References m_dataPath.

Referenced by LoadIndexFiles(), and TestFadingTraces().

Here is the caller graph for this function:

◆ TestFadingTraces()

bool ns3::SatFadingExternalInputTraceContainer::TestFadingTraces	(	uint32_t	numOfUts,
		uint32_t	numOfGws )

A method to test that the fading traces are according to assumptions.

Parameters

numOfUts	number of UTs to test
numOfGws	number of GWs to test

Returns: boolean value indicating success or failure

Definition at line 261 of file satellite-fading-external-input-trace-container.cc.

References CreateGwFadingTrace(), CreateUtFadingTrace(), m_gwFadingMap, m_gwFwdUpFileNames, m_gwFwdUpIndexFileName, m_gwRtnDownFileNames, m_gwRtnDownIndexFileName, m_indexFilesLoaded, m_utFadingMap, m_utFwdDownFileNames, m_utFwdDownIndexFileName, m_utRtnUpFileNames, m_utRtnUpIndexFileName, and ReadIndexFile().

Here is the call graph for this function:

Member Data Documentation

◆ m_dataPath

std::string ns3::SatFadingExternalInputTraceContainer::m_dataPath

private

data path to find trace input files

Definition at line 185 of file satellite-fading-external-input-trace-container.h.

Referenced by CreateFadingTrace(), NotifyConstructionCompleted(), and ReadIndexFile().

◆ m_gwFadingMap

std::map<uint32_t, ChannelTracePair_t> ns3::SatFadingExternalInputTraceContainer::m_gwFadingMap

private

Container of the GW fading traces.

Definition at line 125 of file satellite-fading-external-input-trace-container.h.

Referenced by ~SatFadingExternalInputTraceContainer(), CreateGwFadingTrace(), GetFadingTrace(), and TestFadingTraces().

◆ m_gwFwdUpFileNames

TraceFileContainer_t ns3::SatFadingExternalInputTraceContainer::m_gwFwdUpFileNames

private

GW forward up link trace file names.

Definition at line 169 of file satellite-fading-external-input-trace-container.h.

Referenced by CreateGwFadingTrace(), LoadIndexFiles(), and TestFadingTraces().

◆ m_gwFwdUpIndexFileName

std::string ns3::SatFadingExternalInputTraceContainer::m_gwFwdUpIndexFileName

private

The name of file which defines the index table to be used for trace input of forward up link for GWs.

Index table defines files used as trace input sources.

Definition at line 148 of file satellite-fading-external-input-trace-container.h.

Referenced by GetTypeId(), LoadIndexFiles(), and TestFadingTraces().

◆ m_gwRtnDownFileNames

TraceFileContainer_t ns3::SatFadingExternalInputTraceContainer::m_gwRtnDownFileNames

private

GW return down link trace file names.

Definition at line 174 of file satellite-fading-external-input-trace-container.h.

Referenced by CreateGwFadingTrace(), LoadIndexFiles(), and TestFadingTraces().

◆ m_gwRtnDownIndexFileName

std::string ns3::SatFadingExternalInputTraceContainer::m_gwRtnDownIndexFileName

private

The name of file which defines the index table to be used for trace input of forward up link for GWs.

Index table defines files used as trace input sources.

Definition at line 154 of file satellite-fading-external-input-trace-container.h.

Referenced by GetTypeId(), LoadIndexFiles(), and TestFadingTraces().

◆ m_indexFilesLoaded

bool ns3::SatFadingExternalInputTraceContainer::m_indexFilesLoaded

private

flag telling if index trace files are already loaded

Definition at line 182 of file satellite-fading-external-input-trace-container.h.

Referenced by SatFadingExternalInputTraceContainer(), CreateGwFadingTrace(), CreateUtFadingTrace(), LoadIndexFiles(), and TestFadingTraces().

◆ m_loadedTraces

TraceInputContainer_t ns3::SatFadingExternalInputTraceContainer::m_loadedTraces

private

Loaded trace files.

Definition at line 179 of file satellite-fading-external-input-trace-container.h.

Referenced by CreateFadingTrace().

◆ m_maxDistanceToFading

double ns3::SatFadingExternalInputTraceContainer::m_maxDistanceToFading

private

Maximum distance allowed to the external fading trace source.

Definition at line 188 of file satellite-fading-external-input-trace-container.h.

Referenced by SatFadingExternalInputTraceContainer(), FindSourceBasedOnPosition(), and GetTypeId().

◆ m_utFadingMap

std::map<uint32_t, ChannelTracePair_t> ns3::SatFadingExternalInputTraceContainer::m_utFadingMap

private

Container of the UT fading traces.

Definition at line 120 of file satellite-fading-external-input-trace-container.h.

Referenced by ~SatFadingExternalInputTraceContainer(), CreateUtFadingTrace(), GetFadingTrace(), and TestFadingTraces().

◆ m_utFwdDownFileNames

TraceFileContainer_t ns3::SatFadingExternalInputTraceContainer::m_utFwdDownFileNames

private

UT forward down link trace file names.

Definition at line 159 of file satellite-fading-external-input-trace-container.h.

Referenced by CreateUtFadingTrace(), LoadIndexFiles(), and TestFadingTraces().

◆ m_utFwdDownIndexFileName

std::string ns3::SatFadingExternalInputTraceContainer::m_utFwdDownIndexFileName

private

The name of file which defines the index table to be used for trace input of forward down link for UT.

Index table defines files used as trace input sources.

Definition at line 136 of file satellite-fading-external-input-trace-container.h.

Referenced by GetTypeId(), LoadIndexFiles(), and TestFadingTraces().

◆ m_utInputMode

InputMode_t ns3::SatFadingExternalInputTraceContainer::m_utInputMode

private

Input mode to read trace files form given index table (file) for UTs.

Definition at line 130 of file satellite-fading-external-input-trace-container.h.

Referenced by SatFadingExternalInputTraceContainer(), CreateFadingTrace(), CreateUtFadingTrace(), and GetTypeId().

◆ m_utRtnUpFileNames

TraceFileContainer_t ns3::SatFadingExternalInputTraceContainer::m_utRtnUpFileNames

private

UT return up link trace file names.

Definition at line 164 of file satellite-fading-external-input-trace-container.h.

Referenced by CreateUtFadingTrace(), LoadIndexFiles(), and TestFadingTraces().

◆ m_utRtnUpIndexFileName

std::string ns3::SatFadingExternalInputTraceContainer::m_utRtnUpIndexFileName

private

The name of file which defines the index table to be used for trace input of return up link for UTs.

Index table defines files used as trace input sources.

Definition at line 142 of file satellite-fading-external-input-trace-container.h.

Referenced by GetTypeId(), LoadIndexFiles(), and TestFadingTraces().

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

/builds/sns3/satellite/satellite/model/satellite-fading-external-input-trace-container.h
/builds/sns3/satellite/satellite/model/satellite-fading-external-input-trace-container.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ChannelTracePair_t

◆ TraceFileContainer_t

◆ TraceFileContainerItem_t

◆ TraceInputContainer_t

Member Enumeration Documentation

◆ InputMode_t

Constructor & Destructor Documentation

◆ SatFadingExternalInputTraceContainer()

◆ ~SatFadingExternalInputTraceContainer()

Member Function Documentation

◆ CreateFadingTrace()

◆ CreateGwFadingTrace()

◆ CreateUtFadingTrace()

◆ FindSourceBasedOnPosition()

◆ GetFadingTrace()

◆ GetTypeId()

◆ LoadIndexFiles()

◆ NotifyConstructionCompleted()

◆ ReadIndexFile()

◆ TestFadingTraces()

Member Data Documentation

◆ m_dataPath

◆ m_gwFadingMap

◆ m_gwFwdUpFileNames

◆ m_gwFwdUpIndexFileName

◆ m_gwRtnDownFileNames

◆ m_gwRtnDownIndexFileName

◆ m_indexFilesLoaded

◆ m_loadedTraces

◆ m_maxDistanceToFading

◆ m_utFadingMap

◆ m_utFwdDownFileNames

◆ m_utFwdDownIndexFileName

◆ m_utInputMode

◆ m_utRtnUpFileNames

◆ m_utRtnUpIndexFileName