Class for Rx power output trace container. More...

#include "satellite-rx-power-output-trace-container.h"

Inheritance diagram for ns3::SatRxPowerOutputTraceContainer:

Collaboration diagram for ns3::SatRxPowerOutputTraceContainer:

Public Types
typedef std::map< key_t, Ptr< SatOutputFileStreamDoubleContainer > >	container_t
	typedef for map of containers More...

typedef std::pair< Address, SatEnums::ChannelType_t >	key_t
	typedef for map key More...

Public Member Functions
	SatRxPowerOutputTraceContainer ()
	Constructor. More...

	~SatRxPowerOutputTraceContainer ()
	Destructor. More...

void	AddToContainer (key_t key, std::vector< double > newItem)
	Add the vector containing the values to container matching the key. More...

void	DoDispose ()
	Do needed dispose actions. More...

void	EnableFigureOutput (bool enableFigureOutput)
	Function for enabling / disabling figure output. More...

TypeId	GetInstanceTypeId (void) const
	NS-3 instance type id function. More...

void	Reset ()
	Function for resetting the variables. More...

Public Member Functions inherited from ns3::SatBaseTraceContainer
	SatBaseTraceContainer ()
	Constructor. More...

virtual	~SatBaseTraceContainer ()
	Destructor. More...

TypeId	GetInstanceTypeId (void) const
	NS-3 instance type id function. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	NS-3 type id function. More...

Static Public Member Functions inherited from ns3::SatBaseTraceContainer
static TypeId	GetTypeId (void)
	NS-3 type id function. More...

Private Member Functions
Ptr< SatOutputFileStreamDoubleContainer >	AddNode (std::pair< Address, SatEnums::ChannelType_t > key)
	Function for adding the node to the map. More...

Ptr< SatOutputFileStreamDoubleContainer >	FindNode (key_t key)
	Function for finding the container matching the key. More...

void	WriteToFile ()
	Write the contents of a container matching to the key into a file. More...

Private Attributes
container_t	m_container
	Map for containers. More...

bool	m_enableFigureOutput
	Switch for figure output. More...

Additional Inherited Members
Static Public Attributes inherited from ns3::SatBaseTraceContainer
static const uint32_t	CSINR_TRACE_DEFAULT_FADING_VALUE_INDEX = 1
	Default sinr value index for composite sinr traces. More...

static const uint32_t	CSINR_TRACE_DEFAULT_NUMBER_OF_COLUMNS = 2
	Default number of columns for composite sinr traces. More...

static const uint32_t	FADING_TRACE_DEFAULT_FADING_VALUE_INDEX = 1
	Default fading value index for fading traces. More...

static const uint32_t	FADING_TRACE_DEFAULT_NUMBER_OF_COLUMNS = 2
	Default number of columns for fading traces. More...

static const uint32_t	INTF_TRACE_DEFAULT_INTF_DENSITY_INDEX = 1
	Default interference density index for interference traces. More...

static const uint32_t	INTF_TRACE_DEFAULT_NUMBER_OF_COLUMNS = 2
	Default number of columns for interference traces. More...

static const uint32_t	POSITION_TRACE_DEFAULT_ALTITUDE_INDEX = 3
	Default altitude value index for positions traces. More...

static const uint32_t	POSITION_TRACE_DEFAULT_LATITUDE_INDEX = 1
	Default latitude value index for positions traces. More...

static const uint32_t	POSITION_TRACE_DEFAULT_LONGITUDE_INDEX = 2
	Default longitude value index for positions traces. More...

static const uint32_t	POSITION_TRACE_DEFAULT_NUMBER_OF_COLUMNS = 4
	Default number of columns for position traces. More...

static const uint32_t	RX_CNO_TRACE_DEFAULT_NUMBER_OF_COLUMNS = 2
	Default Rx power density index for Rx power traces. More...

static const uint32_t	RX_CNO_TRACE_DEFAULT_RX_POWER_DENSITY_INDEX = 1
	Default Rx power density index for Rx power traces. More...

static const uint32_t	RX_POWER_TRACE_DEFAULT_NUMBER_OF_COLUMNS = 2
	Default Rx C/N0 index for C/N0 traces. More...

static const uint32_t	RX_POWER_TRACE_DEFAULT_RX_POWER_DENSITY_INDEX = 1
	Default Rx C/N0 index for C/N0 traces. More...

Detailed Description

Class for Rx power output trace container.

The class contains multiple Rx power output sample traces and provides an interface to them.

Definition at line 38 of file satellite-rx-power-output-trace-container.h.

Member Typedef Documentation

◆ container_t

typedef std::map<key_t, Ptr<SatOutputFileStreamDoubleContainer> > ns3::SatRxPowerOutputTraceContainer::container_t

typedef for map of containers

Definition at line 49 of file satellite-rx-power-output-trace-container.h.

◆ key_t

typedef std::pair<Address, SatEnums::ChannelType_t> ns3::SatRxPowerOutputTraceContainer::key_t

typedef for map key

Definition at line 44 of file satellite-rx-power-output-trace-container.h.

Constructor & Destructor Documentation

◆ SatRxPowerOutputTraceContainer()

ns3::SatRxPowerOutputTraceContainer::SatRxPowerOutputTraceContainer ( )

Constructor.

Definition at line 54 of file satellite-rx-power-output-trace-container.cc.

◆ ~SatRxPowerOutputTraceContainer()

ns3::SatRxPowerOutputTraceContainer::~SatRxPowerOutputTraceContainer ( )

Destructor.

Definition at line 60 of file satellite-rx-power-output-trace-container.cc.

References Reset().

Here is the call graph for this function:

Member Function Documentation

◆ AddNode()

Ptr< SatOutputFileStreamDoubleContainer > ns3::SatRxPowerOutputTraceContainer::AddNode ( std::pair< Address, SatEnums::ChannelType_t > key )

private

Function for adding the node to the map.

Parameters

key key

Returns: pointer to the added container

Definition at line 92 of file satellite-rx-power-output-trace-container.cc.

References ns3::SatEnums::GetChannelTypeName(), m_container, and ns3::SatBaseTraceContainer::RX_POWER_TRACE_DEFAULT_NUMBER_OF_COLUMNS.

Referenced by FindNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddToContainer()

void ns3::SatRxPowerOutputTraceContainer::AddToContainer	(	key_t	key,
		std::vector< double >	newItem
	)

Add the vector containing the values to container matching the key.

Parameters

key	key
newItem	vector of values

Definition at line 177 of file satellite-rx-power-output-trace-container.cc.

References FindNode(), and ns3::SatBaseTraceContainer::RX_POWER_TRACE_DEFAULT_NUMBER_OF_COLUMNS.

Here is the call graph for this function:

◆ DoDispose()

void ns3::SatRxPowerOutputTraceContainer::DoDispose ( void )

Do needed dispose actions.

Definition at line 68 of file satellite-rx-power-output-trace-container.cc.

References Reset().

Here is the call graph for this function:

◆ EnableFigureOutput()

void ns3::SatRxPowerOutputTraceContainer::EnableFigureOutput ( bool enableFigureOutput )

inline

Function for enabling / disabling figure output.

Parameters

enableFigureOutput

Definition at line 89 of file satellite-rx-power-output-trace-container.h.

References m_enableFigureOutput.

◆ FindNode()

Ptr< SatOutputFileStreamDoubleContainer > ns3::SatRxPowerOutputTraceContainer::FindNode ( key_t key )

private

Function for finding the container matching the key.

Parameters

key key

Returns: matching container

Definition at line 140 of file satellite-rx-power-output-trace-container.cc.

References AddNode(), and m_container.

Referenced by AddToContainer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceTypeId()

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

NS-3 instance type id function.

Returns: Instance type is

Definition at line 47 of file satellite-rx-power-output-trace-container.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::SatRxPowerOutputTraceContainer::GetTypeId ( void )

static

NS-3 type id function.

Returns: type id

Definition at line 38 of file satellite-rx-power-output-trace-container.cc.

Referenced by GetInstanceTypeId().

Here is the caller graph for this function:

◆ Reset()

void ns3::SatRxPowerOutputTraceContainer::Reset ( void )

virtual

Function for resetting the variables.

Implements ns3::SatBaseTraceContainer.

Definition at line 78 of file satellite-rx-power-output-trace-container.cc.

References m_container, m_enableFigureOutput, and WriteToFile().

Referenced by ~SatRxPowerOutputTraceContainer(), and DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteToFile()

void ns3::SatRxPowerOutputTraceContainer::WriteToFile ( )

private

Write the contents of a container matching to the key into a file.

Definition at line 155 of file satellite-rx-power-output-trace-container.cc.

References ns3::SatOutputFileStreamDoubleContainer::DECIBEL, m_container, and m_enableFigureOutput.

Referenced by Reset().

Here is the caller graph for this function:

Member Data Documentation

◆ m_container

container_t ns3::SatRxPowerOutputTraceContainer::m_container

private

Map for containers.

Definition at line 123 of file satellite-rx-power-output-trace-container.h.

Referenced by AddNode(), FindNode(), Reset(), and WriteToFile().

◆ m_enableFigureOutput

bool ns3::SatRxPowerOutputTraceContainer::m_enableFigureOutput

private

Switch for figure output.

Definition at line 128 of file satellite-rx-power-output-trace-container.h.

Referenced by EnableFigureOutput(), Reset(), and WriteToFile().

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

/builds/sns3/satellite/satellite/model/satellite-rx-power-output-trace-container.h
/builds/sns3/satellite/satellite/model/satellite-rx-power-output-trace-container.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ container_t

◆ key_t

Constructor & Destructor Documentation

◆ SatRxPowerOutputTraceContainer()

◆ ~SatRxPowerOutputTraceContainer()

Member Function Documentation

◆ AddNode()

◆ AddToContainer()

◆ DoDispose()

◆ EnableFigureOutput()

◆ FindNode()

◆ GetInstanceTypeId()

◆ GetTypeId()

◆ Reset()

◆ WriteToFile()

Member Data Documentation

◆ m_container

◆ m_enableFigureOutput