This class implements super frame sequence. More...

#include "satellite-superframe-sequence.h"

Inheritance diagram for ns3::SatSuperframeSeq:

Collaboration diagram for ns3::SatSuperframeSeq:

Public Types
typedef std::vector< Ptr< SatSuperframeConf > >	SatSuperframeConfList
	Define type SatSuperframeConfList.

Public Member Functions
	SatSuperframeSeq ()
	Default constructor for SatSuperframeConf.
	~SatSuperframeSeq ()
	Destructor for SatSuperframeSeq.
void	AddSuperframe (Ptr< SatSuperframeConf > conf)
	Add super frame (configuration) to super frame sequence.
void	AddWaveformConf (Ptr< SatWaveformConf > wfConf)
	Add waveform configuration class instance to this superframe sequence.
double	GetCarrierBandwidthHz (uint32_t carrierId, SatEnums::CarrierBandwidthType_t bandwidthType) const
	Get the bandwidth of the requested carrier.
uint32_t	GetCarrierCount () const
	Get carrier count of the super frame sequence.
uint32_t	GetCarrierCount (uint8_t seqId) const
	Get carrier count in the super frame.
double	GetCarrierFrequencyHz (uint32_t carrierId) const
	Get the center frequency of the requested carrier.
uint32_t	GetCarrierId (uint8_t superframeId, uint8_t frameId, uint16_t frameCarrierId) const
	Get global carrier id.
Time	GetDuration (uint8_t seqId) const
	Get duration of the super frame.
Ptr< SatSuperframeConf >	GetSuperframeConf (uint8_t seqId) const
	Get superframe conf of the sequence.
Time	GetTargetDuration () const
	Get target duration for sequence.
Ptr< SatWaveformConf >	GetWaveformConf () const
	Get waveform configuration.

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

Private Types
typedef std::map< uint32_t, Ptr< SatControlMsgContainer > >	TbtpMap_t

Private Attributes
SatSuperframeConfList	m_superframe
	Super frame sequences.
Time	m_targetDuration
	Target duration time for sequence.
Ptr< SatWaveformConf >	m_wfConf
	Waveform configurations.

Detailed Description

This class implements super frame sequence.

It consists information of the super frames in sequence.

Definition at line 44 of file satellite-superframe-sequence.h.

Member Typedef Documentation

◆ SatSuperframeConfList

typedef std::vector<Ptr<SatSuperframeConf> > ns3::SatSuperframeSeq::SatSuperframeConfList

Define type SatSuperframeConfList.

Definition at line 50 of file satellite-superframe-sequence.h.

◆ TbtpMap_t

typedef std::map<uint32_t, Ptr<SatControlMsgContainer> > ns3::SatSuperframeSeq::TbtpMap_t

private

Definition at line 161 of file satellite-superframe-sequence.h.

Constructor & Destructor Documentation

◆ SatSuperframeSeq()

ns3::SatSuperframeSeq::SatSuperframeSeq ( )

Default constructor for SatSuperframeConf.

Definition at line 36 of file satellite-superframe-sequence.cc.

◆ ~SatSuperframeSeq()

ns3::SatSuperframeSeq::~SatSuperframeSeq ( )

Destructor for SatSuperframeSeq.

Definition at line 41 of file satellite-superframe-sequence.cc.

Member Function Documentation

◆ AddSuperframe()

void ns3::SatSuperframeSeq::AddSuperframe ( Ptr< SatSuperframeConf > conf )

Add super frame (configuration) to super frame sequence.

Parameters

conf	Super frame configuration to add. (id of the sequence is order number of addition starting from 0)

Definition at line 76 of file satellite-superframe-sequence.cc.

References m_superframe.

◆ AddWaveformConf()

void ns3::SatSuperframeSeq::AddWaveformConf ( Ptr< SatWaveformConf > wfConf )

Add waveform configuration class instance to this superframe sequence.

Parameters

wfConf Waveform conf to add

Definition at line 62 of file satellite-superframe-sequence.cc.

References m_wfConf.

◆ GetCarrierBandwidthHz()

double ns3::SatSuperframeSeq::GetCarrierBandwidthHz	(	uint32_t	carrierId,
		SatEnums::CarrierBandwidthType_t	bandwidthType ) const

Get the bandwidth of the requested carrier.

Parameters

carrierId	Id of the carrier inside super frame which bandwidth is requested.
bandwidthType	Type of bandwidth requested.

Returns: The bandwidth of the requested carrier.

Definition at line 183 of file satellite-superframe-sequence.cc.

References m_superframe.

◆ GetCarrierCount() [1/2]

uint32_t ns3::SatSuperframeSeq::GetCarrierCount ( ) const

Get carrier count of the super frame sequence.

Returns: The super frame sequence carrier count.

Definition at line 84 of file satellite-superframe-sequence.cc.

References m_superframe.

◆ GetCarrierCount() [2/2]

uint32_t ns3::SatSuperframeSeq::GetCarrierCount ( uint8_t seqId ) const

Get carrier count in the super frame.

Parameters

seqId Sequence id of the super frame which carrier count is requested.

Returns: The super frame carrier count.

Definition at line 99 of file satellite-superframe-sequence.cc.

References m_superframe.

◆ GetCarrierFrequencyHz()

double ns3::SatSuperframeSeq::GetCarrierFrequencyHz ( uint32_t carrierId ) const

Get the center frequency of the requested carrier.

Parameters

carrierId Id of the carrier inside super frame which center frequency is requested.

Returns: The center frequency of the requested carrier.

Definition at line 159 of file satellite-superframe-sequence.cc.

References m_superframe.

◆ GetCarrierId()

uint32_t ns3::SatSuperframeSeq::GetCarrierId	(	uint8_t	superframeId,
		uint8_t	frameId,
		uint16_t	frameCarrierId ) const

Get global carrier id.

Converts super frame specific id to global carrier id.

Parameters

superframeId	Id of the super frame requested.
frameId	Id of the frame inside super frame requested.
frameCarrierId	Id of the carrier inside frame requested.