ns3::SatRxCnoInputTraceContainer Class Reference

Class for Rx C/N0 input trace container. More...

#include "satellite-rx-cno-input-trace-container.h"

Inheritance diagram for ns3::SatRxCnoInputTraceContainer:

Collaboration diagram for ns3::SatRxCnoInputTraceContainer:

Public Types
typedef std::map< key_t, Ptr< SatInputFileStreamTimeDoubleContainer > >	container_t
	typedef for map of containers More...
typedef std::map< key_t, double >	containerConstantCno_t
	typedef for map of containers More...
typedef std::pair< Address, SatEnums::ChannelType_t >	key_t
	typedef for map key More...

Public Member Functions
	SatRxCnoInputTraceContainer ()
	Constructor. More...
	~SatRxCnoInputTraceContainer ()
	Destructor. More...
Ptr< SatInputFileStreamTimeDoubleContainer >	AddNode (std::pair< Address, SatEnums::ChannelType_t > key)
	Function for adding the node to the map. More...
void	DoDispose ()
	Do needed dispose actions. More...
TypeId	GetInstanceTypeId (void) const
	NS-3 instance type id function. More...
double	GetRxCno (key_t key)
	Function for getting the Rx C/N0. More...
void	Reset ()
	Function for resetting the variables. More...
void	SetRxCno (key_t key, double cno)
	Function for setting the Rx C/N0 with constant value. More...
void	SetRxCnoFile (key_t key, std::string path)
	Function for setting the Rx C/N0 with input file. 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< SatInputFileStreamTimeDoubleContainer >	FindNode (key_t key)
	Function for finding the container matching the key. More...

Private Attributes
container_t	m_container
	Map for containers. More...
containerConstantCno_t	m_containerConstantCno
	Container to store the constant values of C/N0. 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 C/N0 input trace container.

The class contains multiple Rx C/N0 input sample traces and provides an interface to them. It can also be set manually to a constant for chosen nodes.

Definition at line 45 of file satellite-rx-cno-input-trace-container.h.

Member Typedef Documentation

container_t

typedef std::map<key_t, Ptr<SatInputFileStreamTimeDoubleContainer> > ns3::SatRxCnoInputTraceContainer::container_t

typedef for map of containers

Definition at line 56 of file satellite-rx-cno-input-trace-container.h.

containerConstantCno_t

typedef std::map<key_t, double> ns3::SatRxCnoInputTraceContainer::containerConstantCno_t

typedef for map of containers

Definition at line 61 of file satellite-rx-cno-input-trace-container.h.

key_t

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

typedef for map key

Definition at line 51 of file satellite-rx-cno-input-trace-container.h.

Constructor & Destructor Documentation

SatRxCnoInputTraceContainer()

ns3::SatRxCnoInputTraceContainer::SatRxCnoInputTraceContainer

(

)

Constructor.

Definition at line 59 of file satellite-rx-cno-input-trace-container.cc.

~SatRxCnoInputTraceContainer()

ns3::SatRxCnoInputTraceContainer::~SatRxCnoInputTraceContainer

(

)

Destructor.

Definition at line 64 of file satellite-rx-cno-input-trace-container.cc.

References Reset().

Here is the call graph for this function:

Member Function Documentation

AddNode()

Ptr< SatInputFileStreamTimeDoubleContainer > ns3::SatRxCnoInputTraceContainer::AddNode

(

std::pair< Address, SatEnums::ChannelType_t >

key

)

Function for adding the node to the map.

Parameters

key

key

Returns

pointer to the added container

Definition at line 98 of file satellite-rx-cno-input-trace-container.cc.

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

Referenced by FindNode().

Here is the call graph for this function:

Here is the caller graph for this function:

DoDispose()

void ns3::SatRxCnoInputTraceContainer::DoDispose

(

void

)

Do needed dispose actions.

Definition at line 72 of file satellite-rx-cno-input-trace-container.cc.

References Reset().

Here is the call graph for this function:

FindNode()

Ptr< SatInputFileStreamTimeDoubleContainer > ns3::SatRxCnoInputTraceContainer::FindNode ( key_t  key )

private

Function for finding the container matching the key.

Parameters

key

key

Returns

matching container

Definition at line 149 of file satellite-rx-cno-input-trace-container.cc.

References AddNode(), and m_container.

Referenced by GetRxCno().

Here is the call graph for this function:

Here is the caller graph for this function:

GetInstanceTypeId()

TypeId ns3::SatRxCnoInputTraceContainer::GetInstanceTypeId

(

void

)

const

NS-3 instance type id function.

Returns

Instance type is

Definition at line 52 of file satellite-rx-cno-input-trace-container.cc.

References GetTypeId().

Here is the call graph for this function:

GetRxCno()

double ns3::SatRxCnoInputTraceContainer::GetRxCno

(

key_t

key

)

Function for getting the Rx C/N0.

Parameters

key

key

Returns

Rx C/N0

Definition at line 164 of file satellite-rx-cno-input-trace-container.cc.

References FindNode(), m_containerConstantCno, and ns3::SatBaseTraceContainer::RX_CNO_TRACE_DEFAULT_RX_POWER_DENSITY_INDEX.

Here is the call graph for this function:

GetTypeId()

TypeId ns3::SatRxCnoInputTraceContainer::GetTypeId ( void  )

static

NS-3 type id function.

Returns

type id

Definition at line 43 of file satellite-rx-cno-input-trace-container.cc.

Referenced by GetInstanceTypeId().

Here is the caller graph for this function:

Reset()

void ns3::SatRxCnoInputTraceContainer::Reset ( void  )

virtual

Function for resetting the variables.

Implements ns3::SatBaseTraceContainer.

Definition at line 82 of file satellite-rx-cno-input-trace-container.cc.

References m_container, and m_containerConstantCno.

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

Here is the caller graph for this function:

SetRxCno()

void ns3::SatRxCnoInputTraceContainer::SetRxCno	(	key_t	key,
		double	cno
	)

Function for setting the Rx C/N0 with constant value.

Parameters

key	key
cno	C/N0

Definition at line 181 of file satellite-rx-cno-input-trace-container.cc.

References m_containerConstantCno.

SetRxCnoFile()

void ns3::SatRxCnoInputTraceContainer::SetRxCnoFile	(	key_t	key,
		std::string	path
	)

Function for setting the Rx C/N0 with input file.

Parameters

key	key
path	path to C/N0 file

Definition at line 204 of file satellite-rx-cno-input-trace-container.cc.

References m_container, m_containerConstantCno, and ns3::SatBaseTraceContainer::RX_CNO_TRACE_DEFAULT_NUMBER_OF_COLUMNS.

Member Data Documentation

m_container

container_t ns3::SatRxCnoInputTraceContainer::m_container

private

Map for containers.

Definition at line 135 of file satellite-rx-cno-input-trace-container.h.

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

m_containerConstantCno

containerConstantCno_t ns3::SatRxCnoInputTraceContainer::m_containerConstantCno

private

Container to store the constant values of C/N0.

Overrides the use of an input file for them.

Definition at line 141 of file satellite-rx-cno-input-trace-container.h.

Referenced by GetRxCno(), Reset(), SetRxCno(), and SetRxCnoFile().

---

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

• /builds/sns3/satellite/satellite/model/satellite-rx-cno-input-trace-container.h
• /builds/sns3/satellite/satellite/model/satellite-rx-cno-input-trace-container.cc