Abstract class for storing link results. More...

#include "satellite-link-results.h"

Inheritance diagram for ns3::SatLinkResults:

Collaboration diagram for ns3::SatLinkResults:

Public Member Functions
	SatLinkResults ()
	Default constructor. More...

void	Initialize ()
	Initialize look up tables. More...

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

Protected Member Functions
virtual void	DoInitialize ()=0
	Initialize look up tables. More...

Protected Attributes
std::string	m_inputPath
	The base path where the text files containing link results data can be found. More...

bool	m_isInitialized
	Indicates if SatLinkResults::Initialize has been called. More...

Detailed Description

Abstract class for storing link results.

This class cannot be instantiated. Use the child classes instead.

The child class is expected to load and handle multiple SatLookUpTable, and provide query service on it.

Usage example:

Ptr<SatLinkResultsDvbRcs2> linkDvbRcs2 = CreateObject<SatLinkResultsDvbRcs2> ();
Ptr<SatLinkResultsDvbS2> linkDvbS2 = CreateObject<SatLinkResultsDvbRcs2> ();
linkDvbRcs2->Initialize ();
linkDvbS2->Initialize ();

Definition at line 55 of file satellite-link-results.h.

Constructor & Destructor Documentation

◆ SatLinkResults()

ns3::SatLinkResults::SatLinkResults ( )

Default constructor.

Definition at line 46 of file satellite-link-results.cc.

References m_inputPath.

Member Function Documentation

◆ DoInitialize()

virtual void ns3::SatLinkResults::DoInitialize ( )

protectedpure virtual

Initialize look up tables.

Child classes must implement this function to initialize m_table member variable. This is typically done by loading pre-defined input files from the file system. In case of failure, the function should throw an error by calling NS_FATAL_ERROR.

Implemented in ns3::SatLinkResultsFwd, ns3::SatLinkResultsRtn, ns3::SatLinkResultsDvbS2X, ns3::SatLinkResultsDvbS2, ns3::SatLinkResultsLora, ns3::SatLinkResultsFSim, and ns3::SatLinkResultsDvbRcs2.

Referenced by Initialize().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SatLinkResults::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 54 of file satellite-link-results.cc.

◆ Initialize()

void ns3::SatLinkResults::Initialize ( )

Initialize look up tables.

Must be called before any SatLinkResults::GetBler can be invoked.

Simply calls SatLinkResults::DoInitialize.

Definition at line 61 of file satellite-link-results.cc.

References DoInitialize(), and m_isInitialized.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputPath

std::string ns3::SatLinkResults::m_inputPath

protected

The base path where the text files containing link results data can be found.

Definition at line 93 of file satellite-link-results.h.

Referenced by SatLinkResults(), ns3::SatLinkResultsDvbRcs2::DoInitialize(), ns3::SatLinkResultsFSim::DoInitialize(), ns3::SatLinkResultsLora::DoInitialize(), ns3::SatLinkResultsDvbS2::DoInitialize(), and ns3::SatLinkResultsDvbS2X::DoInitialize().

◆ m_isInitialized

bool ns3::SatLinkResults::m_isInitialized

protected

Indicates if SatLinkResults::Initialize has been called.

Definition at line 98 of file satellite-link-results.h.

Referenced by ns3::SatLinkResultsFwd::GetBler(), ns3::SatLinkResultsRtn::GetBler(), ns3::SatLinkResultsRtn::GetEbNoDb(), ns3::SatLinkResultsFwd::GetEsNoDb(), and Initialize().

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

/builds/sns3/satellite/satellite/model/satellite-link-results.h
/builds/sns3/satellite/satellite/model/satellite-link-results.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes