ns3::SatTimeSlotConf Class Reference

This class implements configuration for time slots (for super frames / frames) More...

#include "satellite-frame-conf.h"

Inheritance diagram for ns3::SatTimeSlotConf:

Collaboration diagram for ns3::SatTimeSlotConf:

Public Types
enum	SatTimeSlotType_t { SLOT_TYPE_C , SLOT_TYPE_TR , SLOT_TYPE_TRC }
	Types for time slot. More...

Public Member Functions
	SatTimeSlotConf ()
	Default constructor for SatTimeSlotConf. More...
	SatTimeSlotConf (Time startTime, uint32_t waveFormId, uint16_t carrierId, SatTimeSlotConf::SatTimeSlotType_t slotType)
	Constructor for SatTimeSlotConf. More...
	~SatTimeSlotConf ()
	Destructor for SatTimeSlotConf. More...
uint16_t	GetCarrierId () const
	Get carrier id of time slot (inside frame). More...
uint8_t	GetRcIndex ()
	Get RC index of the time slot. More...
SatTimeSlotConf::SatTimeSlotType_t	GetSlotType () const
	Get time slot type. More...
Time	GetStartTime () const
	Get start time of time slot. More...
uint32_t	GetWaveFormId () const
	Get wave form id of time slot. More...
void	SetRcIndex (uint8_t rcIndex)
	Set RC index of the time slot. More...
void	SetSlotType (SatTimeSlotConf::SatTimeSlotType_t slotType)
	Set time slot type. More...

Private Attributes
uint16_t	m_frameCarrierId
uint8_t	m_rcIndex
SatTimeSlotType_t	m_slotType
Time	m_startTime
uint32_t	m_waveFormId

Detailed Description

This class implements configuration for time slots (for super frames / frames)

Definition at line 131 of file satellite-frame-conf.h.

Member Enumeration Documentation

SatTimeSlotType_t

enum ns3::SatTimeSlotConf::SatTimeSlotType_t

Types for time slot.

Enumerator
SLOT_TYPE_C	Control slot.
SLOT_TYPE_TR	Traffic slot.
SLOT_TYPE_TRC	Control or traffic slot.

Definition at line 137 of file satellite-frame-conf.h.

Constructor & Destructor Documentation

SatTimeSlotConf() [1/2]

ns3::SatTimeSlotConf::SatTimeSlotConf

(

)

Default constructor for SatTimeSlotConf.

Definition at line 89 of file satellite-frame-conf.cc.

SatTimeSlotConf() [2/2]

ns3::SatTimeSlotConf::SatTimeSlotConf	(	Time	startTime,
		uint32_t	waveFormId,
		uint16_t	carrierId,
		SatTimeSlotConf::SatTimeSlotType_t	slotType
	)

Constructor for SatTimeSlotConf.

Parameters

startTime	Start time of time slot in side frame.
waveFormId	Wave form id of time slot
carrierId	Carrier id of time slot
slotType	Time slot type

Definition at line 102 of file satellite-frame-conf.cc.

~SatTimeSlotConf()

ns3::SatTimeSlotConf::~SatTimeSlotConf

(

)

Destructor for SatTimeSlotConf.

Definition at line 115 of file satellite-frame-conf.cc.

Member Function Documentation

GetCarrierId()

uint16_t ns3::SatTimeSlotConf::GetCarrierId ( ) const

inline

Get carrier id of time slot (inside frame).

Returns

The carrier id of time slot.

Definition at line 193 of file satellite-frame-conf.h.

References m_frameCarrierId.

GetRcIndex()

uint8_t ns3::SatTimeSlotConf::GetRcIndex ( )

inline

Get RC index of the time slot.

Returns

RC index of the time slot.

Definition at line 213 of file satellite-frame-conf.h.

References m_rcIndex.

GetSlotType()

SatTimeSlotConf::SatTimeSlotType_t ns3::SatTimeSlotConf::GetSlotType ( ) const

inline

Get time slot type.

Returns

Type of the time slot.

Definition at line 223 of file satellite-frame-conf.h.

References m_slotType.

GetStartTime()

Time ns3::SatTimeSlotConf::GetStartTime ( ) const

inline

Get start time of time slot.

(inside frame)

Returns

The start time of time slot.

Definition at line 173 of file satellite-frame-conf.h.

References m_startTime.

GetWaveFormId()

uint32_t ns3::SatTimeSlotConf::GetWaveFormId ( ) const

inline

Get wave form id of time slot.

Returns

The wave form id of time slot.

Definition at line 183 of file satellite-frame-conf.h.

References m_waveFormId.

SetRcIndex()

void ns3::SatTimeSlotConf::SetRcIndex ( uint8_t  rcIndex )

inline

Set RC index of the time slot.

Parameters

rcIndex

RC index of the time slot.

Definition at line 203 of file satellite-frame-conf.h.

References m_rcIndex.

SetSlotType()

void ns3::SatTimeSlotConf::SetSlotType ( SatTimeSlotConf::SatTimeSlotType_t  slotType )

inline

Set time slot type.

Parameters

slotType

Type of the time slot to set.

Definition at line 233 of file satellite-frame-conf.h.

References m_slotType.

Member Data Documentation

m_frameCarrierId

uint16_t ns3::SatTimeSlotConf::m_frameCarrierId

private

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

Referenced by GetCarrierId().

m_rcIndex

uint8_t ns3::SatTimeSlotConf::m_rcIndex

private

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

Referenced by GetRcIndex(), and SetRcIndex().

m_slotType

SatTimeSlotType_t ns3::SatTimeSlotConf::m_slotType

private

Definition at line 244 of file satellite-frame-conf.h.

Referenced by GetSlotType(), and SetSlotType().

m_startTime

Time ns3::SatTimeSlotConf::m_startTime

private

Definition at line 239 of file satellite-frame-conf.h.

Referenced by GetStartTime().

m_waveFormId

uint32_t ns3::SatTimeSlotConf::m_waveFormId

private

Definition at line 240 of file satellite-frame-conf.h.

Referenced by GetWaveFormId().

---

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

• /builds/sns3/satellite/satellite/model/satellite-frame-conf.h
• /builds/sns3/satellite/satellite/model/satellite-frame-conf.cc