Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::SatSuperframeConf Class Referenceabstract

This abstract class defines and implements interface of configuration for super frames. More...

#include "satellite-frame-conf.h"

+ Inheritance diagram for ns3::SatSuperframeConf:
+ Collaboration diagram for ns3::SatSuperframeConf:

Public Types

enum  ConfigType_t {
  CONFIG_TYPE_0 , CONFIG_TYPE_1 , CONFIG_TYPE_2 , CONFIG_TYPE_3 ,
  CONFIG_TYPE_4
}
 Enum for configuration types. More...
 
typedef std::vector< Ptr< SatFrameConf > > SatFrameConfList_t
 Define type SatFrameConfList_t. More...
 
enum  SuperFrameConfiguration_t {
  SUPER_FRAME_CONFIG_0 , SUPER_FRAME_CONFIG_1 , SUPER_FRAME_CONFIG_2 , SUPER_FRAME_CONFIG_3 ,
  SUPER_FRAME_CONFIG_4
}
 Configurable Super Frames. More...
 

Public Member Functions

 SatSuperframeConf ()
 Default constructor for SatSuperframeConf. More...
 
 ~SatSuperframeConf ()
 Destructor for SatSuperframeConf. More...
 
void Configure (double allocatedBandwidthHz, Time targetDuration, Ptr< SatWaveformConf > waveformConf)
 Configures super frame configuration according to set attributes. More...
 
virtual void DoConfigure ()=0
 Do frame specific configuration as needed. More...
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (0)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (1)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (2)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (3)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (4)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (5)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (6)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (7)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (8)
 
 FRAME_ATTRIBUTE_ACCESSOR_DEFINE (9)
 
double GetBandwidthHz () const
 Get bandwidth of the super frame. More...
 
double GetCarrierBandwidthHz (uint32_t carrierId, SatEnums::CarrierBandwidthType_t bandwidthType) const
 Get the bandwidth of the requested carrier. More...
 
uint32_t GetCarrierCount () const
 Get carrier count in the super frame. More...
 
Ptr< SatFrameConf > GetCarrierFrameConf (uint32_t carrierId) const
 Get the frame configuration of the requested carrier. More...
 
double GetCarrierFrequencyHz (uint32_t carrierId) const
 Get the center frequency of the requested carrier. More...
 
uint32_t GetCarrierId (uint8_t frameId, uint16_t frameCarrierId) const
 Get carrier id of the super frame. More...
 
SatSuperframeConf::ConfigType_t GetConfigType () const
 Get frame configuration type to be used in super frame. More...
 
Time GetDuration () const
 Get duration of super frame. More...
 
double GetFrameAllocatedBandwidthHz (uint8_t frameIndex) const
 
uint8_t GetFrameAllocationChannelId (uint8_t frameIndex) const
 
double GetFrameCarrierAllocatedBandwidthHz (uint8_t frameIndex) const
 
double GetFrameCarrierRollOff (uint8_t frameIndex) const
 
double GetFrameCarrierSpacing (uint8_t frameIndex) const
 
uint32_t GetFrameCarrierSpreadingFactor (uint8_t frameIndex) const
 
Ptr< SatFrameConf > GetFrameConf (uint8_t id) const
 Get frame conf of the super frame. More...
 
uint8_t GetFrameCount () const
 Get number of frames to be used in super frame. More...
 
uint8_t GetFrameGuardTimeSymbols (uint8_t frameIndex) const
 
virtual TypeId GetInstanceTypeId (void) const
 Get the type ID of instance. More...
 
uint32_t GetLogonChannelIndex () const
 
uint8_t GetMaxSubdivision () const
 
uint8_t GetRaChannel (uint32_t carrierId) const
 Get the RA channel id (index) corresponding to given (global) carrier id. More...
 
uint8_t GetRaChannelAllocationChannelId (uint8_t raChannel) const
 Get RA channel allocation channel ID. More...
 
uint8_t GetRaChannelCount () const
 Get the number of the RA channels in super frame configuration. More...
 
uint8_t GetRaChannelFrameId (uint8_t raChannel) const
 Get RA channel frame ID. More...
 
uint32_t GetRaChannelTimeSlotPayloadInBytes (uint8_t raChannel) const
 Get the payload of the RA channel time slot in bytes. More...
 
uint16_t GetRaSlotCount (uint8_t raChannel)
 Get RA channel time slot count. More...
 
SatFrameConf::SatTimeSlotConfContainer_t GetRaSlots (uint8_t raChannel)
 Get RA channel time slots. More...
 
bool IsFrameLogon (uint8_t frameIndex) const
 
bool IsFrameRandomAccess (uint8_t frameIndex) const
 
bool IsLogonEnabled () const
 
bool IsRandomAccessCarrier (uint32_t carrierId) const
 Check if given carrier is random access carrier. More...
 
void SetConfigType (SatSuperframeConf::ConfigType_t type)
 Set frame configuration type to be used in super frame. More...
 
void SetFrameAllocatedBandwidthHz (uint8_t frameIndex, double bandwidthHz)
 
void SetFrameAllocationChannelId (uint8_t frameIndex, uint8_t allocationChannel)
 
void SetFrameCarrierAllocatedBandwidthHz (uint8_t frameIndex, double bandwidthHz)
 
void SetFrameCarrierRollOff (uint8_t frameIndex, double rollOff)
 
void SetFrameCarrierSpacing (uint8_t frameIndex, double spacing)
 
void SetFrameCarrierSpreadingFactor (uint8_t frameIndex, uint32_t spreadingFactor)
 
void SetFrameCount (uint8_t frameCount)
 Set number of frames to be used in super frame. More...
 
void SetFrameGuardTimeSymbols (uint8_t frameIndex, uint8_t guardTimeSymbols)
 
void SetFrameLogon (uint8_t frameIndex, bool logon)
 
void SetFrameRandomAccess (uint8_t frameIndex, bool randomAccess)
 
void SetMaxSubdivision (uint8_t maximumCarrierSubdivision)
 

Static Public Member Functions

static Ptr< SatSuperframeConf > CreateSuperframeConf (SuperFrameConfiguration_t conf)
 Create pre-configured super frame configuration-. More...
 
static std::string GetIndexAsFrameName (uint32_t index)
 Method to convert frame index to frame name. More...
 
template<class T >
static std::string GetNumberAsString (T number)
 Template method to convert number to string. More...
 
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Static Public Attributes

static const uint8_t m_maxFrameCount = 10
 

Private Types

typedef std::tuple< uint8_t, uint8_t, uint8_t > RaChannelInfo_t
 

Private Member Functions

void AddFrameConf (SatFrameConf::SatFrameConfParams_t frameConfParameters, double bandwidthInHz, double rollOff, double spacing, uint32_t spreadingFactor, uint8_t subdivisionLevel)
 Add frame configuration to super frame configuration. More...
 
uint8_t GetCarrierFrame (uint32_t carrierId) const
 Get frame id where given global carrier ID belongs to. More...
 

Private Attributes

uint32_t m_carrierCount
 
ConfigType_t m_configType
 
Time m_duration
 
double m_frameAllocatedBandwidth [m_maxFrameCount]
 
uint8_t m_frameAllocationChannel [m_maxFrameCount]
 
double m_frameCarrierAllocatedBandwidth [m_maxFrameCount]
 
double m_frameCarrierRollOff [m_maxFrameCount]
 
double m_frameCarrierSpacing [m_maxFrameCount]
 
uint32_t m_frameCarrierSpreadingFactor [m_maxFrameCount]
 
uint8_t m_frameCount
 
uint8_t m_frameGuardTimeSymbols [m_maxFrameCount]
 
bool m_frameIsLogon [m_maxFrameCount]
 
bool m_frameIsRandomAccess [m_maxFrameCount]
 
SatFrameConfList_t m_frames
 
uint32_t m_logonChannelIndex
 
bool m_logonEnabled
 
uint8_t m_maxCarrierSubdivision
 
std::vector< RaChannelInfo_t > m_raChannels
 
double m_usedBandwidthHz
 

Detailed Description

This abstract class defines and implements interface of configuration for super frames.

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

Member Typedef Documentation

◆ RaChannelInfo_t

typedef std::tuple<uint8_t, uint8_t, uint8_t> ns3::SatSuperframeConf::RaChannelInfo_t
private

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

◆ SatFrameConfList_t

typedef std::vector<Ptr<SatFrameConf> > ns3::SatSuperframeConf::SatFrameConfList_t

Define type SatFrameConfList_t.

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

Member Enumeration Documentation

◆ ConfigType_t

enum ns3::SatSuperframeConf::ConfigType_t

Enum for configuration types.

Enumerator
CONFIG_TYPE_0 

Configuration type 0.

CONFIG_TYPE_1 

Configuration type 1.

CONFIG_TYPE_2 

Configuration type 2.

CONFIG_TYPE_3 

Configuration type 3.

CONFIG_TYPE_4 

Configuration type 4 (ESSA)

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

◆ SuperFrameConfiguration_t

enum ns3::SatSuperframeConf::SuperFrameConfiguration_t

Configurable Super Frames.

Enumerator
SUPER_FRAME_CONFIG_0 

SUPER_FRAME_CONFIG_0.

SUPER_FRAME_CONFIG_1 

SUPER_FRAME_CONFIG_1.

SUPER_FRAME_CONFIG_2 

SUPER_FRAME_CONFIG_2.

SUPER_FRAME_CONFIG_3 

SUPER_FRAME_CONFIG_3.

SUPER_FRAME_CONFIG_4 

SUPER_FRAME_CONFIG_4.

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

Constructor & Destructor Documentation

◆ SatSuperframeConf()

ns3::SatSuperframeConf::SatSuperframeConf ( )

Default constructor for SatSuperframeConf.

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

◆ ~SatSuperframeConf()

ns3::SatSuperframeConf::~SatSuperframeConf ( )

Destructor for SatSuperframeConf.

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

Member Function Documentation

◆ AddFrameConf()

void ns3::SatSuperframeConf::AddFrameConf ( SatFrameConf::SatFrameConfParams_t  frameConfParameters,
double  bandwidthInHz,
double  rollOff,
double  spacing,
uint32_t  spreadingFactor,
uint8_t  subdivisionLevel 
)
private

Add frame configuration to super frame configuration.

Parameters
confFrame configuration to add super frame configuration

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

References ns3::SatFrameConf::SatFrameConfParams_t::m_btuConf, m_carrierCount, m_frames, ns3::SatFrameConf::SatFrameConfParams_t::m_isRandomAccess, m_logonChannelIndex, m_logonEnabled, ns3::SatFrameConf::SatFrameConfParams_t::m_parent, and m_raChannels.

Referenced by Configure().

+ Here is the caller graph for this function:

◆ Configure()

void ns3::SatSuperframeConf::Configure ( double  allocatedBandwidthHz,
Time  targetDuration,
Ptr< SatWaveformConf >  waveformConf 
)

Configures super frame configuration according to set attributes.

Parameters
allocatedBandwidthHzAllocated bandwidth for super frame.
targetDurationTarget duration for super frame sequence
waveformConfWave Form Configuration

Note, that the superframe duration may be a bit longer than the frame durations, since the frame duration is counted based on the time slot duration.

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

References AddFrameConf(), CONFIG_TYPE_0, CONFIG_TYPE_1, CONFIG_TYPE_2, CONFIG_TYPE_3, CONFIG_TYPE_4, DoConfigure(), ns3::SatFrameConf::SatFrameConfParams_t::m_allocationChannel, ns3::SatFrameConf::SatFrameConfParams_t::m_bandwidthHz, ns3::SatFrameConf::SatFrameConfParams_t::m_btuConf, m_carrierCount, ns3::SatFrameConf::SatFrameConfParams_t::m_checkSlotLimit, m_configType, ns3::SatFrameConf::SatFrameConfParams_t::m_defaultWaveformInUse, m_duration, m_frameAllocatedBandwidth, m_frameAllocationChannel, m_frameCarrierAllocatedBandwidth, m_frameCarrierRollOff, m_frameCarrierSpacing, m_frameCarrierSpreadingFactor, m_frameCount, m_frameGuardTimeSymbols, m_frameIsLogon, m_frameIsRandomAccess, m_frames, ns3::SatFrameConf::SatFrameConfParams_t::m_guardTimeSymbols, ns3::SatFrameConf::SatFrameConfParams_t::m_isLogon, ns3::SatFrameConf::SatFrameConfParams_t::m_isRandomAccess, m_maxCarrierSubdivision, ns3::SatFrameConf::SatFrameConfParams_t::m_parent, m_raChannels, ns3::SatFrameConf::SatFrameConfParams_t::m_targetDuration, m_usedBandwidthHz, and ns3::SatFrameConf::SatFrameConfParams_t::m_waveformConf.

+ Here is the call graph for this function:

◆ CreateSuperframeConf()

Ptr< SatSuperframeConf > ns3::SatSuperframeConf::CreateSuperframeConf ( SuperFrameConfiguration_t  conf)
static

Create pre-configured super frame configuration-.

Parameters
confPre-configured super frame configuration to create
Returns
Pointer to created super frame configuration

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

References SUPER_FRAME_CONFIG_0, SUPER_FRAME_CONFIG_1, SUPER_FRAME_CONFIG_2, SUPER_FRAME_CONFIG_3, and SUPER_FRAME_CONFIG_4.

Referenced by ns3::SatConf::Configure().

+ Here is the caller graph for this function:

◆ DoConfigure()

virtual void ns3::SatSuperframeConf::DoConfigure ( )
pure virtual

Do frame specific configuration as needed.

Implemented in ns3::SatSuperframeConf4, ns3::SatSuperframeConf3, ns3::SatSuperframeConf2, ns3::SatSuperframeConf1, and ns3::SatSuperframeConf0.

Referenced by Configure().

+ Here is the caller graph for this function:

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [1/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 0  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [2/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 1  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [3/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 2  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [4/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 3  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [5/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 4  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [6/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 5  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [7/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 6  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [8/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 7  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [9/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 8  )

◆ FRAME_ATTRIBUTE_ACCESSOR_DEFINE() [10/10]

ns3::SatSuperframeConf::FRAME_ATTRIBUTE_ACCESSOR_DEFINE ( 9  )

◆ GetBandwidthHz()

double ns3::SatSuperframeConf::GetBandwidthHz ( ) const
inline

Get bandwidth of the super frame.

Returns
The bandwidth of super frame in hertz.

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

References m_usedBandwidthHz.

◆ GetCarrierBandwidthHz()

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

Get the bandwidth of the requested carrier.

Parameters
carrierIdId of the carrier inside super frame which bandwidth is requested.
bandwidthTypeType of bandwidth requested.
Returns
The bandwidth of the requested carrier.

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

References GetCarrierFrame(), and m_frames.

+ Here is the call graph for this function:

◆ GetCarrierCount()

uint32_t ns3::SatSuperframeConf::GetCarrierCount ( ) const

Get carrier count in the super frame.

Returns
The super frame carrier count.

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

References m_carrierCount.

◆ GetCarrierFrame()

uint8_t ns3::SatSuperframeConf::GetCarrierFrame ( uint32_t  carrierId) const
private

Get frame id where given global carrier ID belongs to.

Parameters
carrierIdCarried ID which frame ID is requested.
Returns
frame id where given global carrier ID belongs to.

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

References m_frames.

Referenced by GetCarrierBandwidthHz(), GetCarrierFrameConf(), GetCarrierFrequencyHz(), GetRaChannel(), and IsRandomAccessCarrier().

+ Here is the caller graph for this function:

◆ GetCarrierFrameConf()

Ptr< SatFrameConf > ns3::SatSuperframeConf::GetCarrierFrameConf ( uint32_t  carrierId) const

Get the frame configuration of the requested carrier.

Parameters
carrierIdId of the carrier inside super frame which frame configuration is requested.
Returns
The SatFrameConf of the requested carrier.

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

References GetCarrierFrame(), and m_frames.

+ Here is the call graph for this function:

◆ GetCarrierFrequencyHz()

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

Get the center frequency of the requested carrier.

Parameters
carrierIdId of the carrier inside super frame which center frequency is requested.
Returns
The center frequency of the requested carrier.

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

References GetCarrierFrame(), and m_frames.

+ Here is the call graph for this function:

◆ GetCarrierId()

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

Get carrier id of the super frame.

Converts frame specific id to super frame specific id.

Parameters
frameIdId of the frame requested.
frameCarrierIdId of the carrier inside frame requested.
Returns
The requested carrier id of the super frame.

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

References m_frames.

◆ GetConfigType()

SatSuperframeConf::ConfigType_t ns3::SatSuperframeConf::GetConfigType ( ) const
inline

Get frame configuration type to be used in super frame.

Returns
the frame configuration type

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

References m_configType.

◆ GetDuration()

Time ns3::SatSuperframeConf::GetDuration ( ) const
inline

Get duration of super frame.

Returns
The duration of super frame in seconds.

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

References m_duration.

◆ GetFrameAllocatedBandwidthHz()

double ns3::SatSuperframeConf::GetFrameAllocatedBandwidthHz ( uint8_t  frameIndex) const

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

References m_frameAllocatedBandwidth, and m_maxFrameCount.

◆ GetFrameAllocationChannelId()

uint8_t ns3::SatSuperframeConf::GetFrameAllocationChannelId ( uint8_t  frameIndex) const

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

References m_frameAllocationChannel, and m_maxFrameCount.

◆ GetFrameCarrierAllocatedBandwidthHz()

double ns3::SatSuperframeConf::GetFrameCarrierAllocatedBandwidthHz ( uint8_t  frameIndex) const

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

References m_frameCarrierAllocatedBandwidth, and m_maxFrameCount.

◆ GetFrameCarrierRollOff()

double ns3::SatSuperframeConf::GetFrameCarrierRollOff ( uint8_t  frameIndex) const

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

References m_frameCarrierRollOff, and m_maxFrameCount.

◆ GetFrameCarrierSpacing()

double ns3::SatSuperframeConf::GetFrameCarrierSpacing ( uint8_t  frameIndex) const

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

References m_frameCarrierSpacing, and m_maxFrameCount.

◆ GetFrameCarrierSpreadingFactor()

uint32_t ns3::SatSuperframeConf::GetFrameCarrierSpreadingFactor ( uint8_t  frameIndex) const

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

References m_frameCarrierSpreadingFactor, and m_maxFrameCount.

◆ GetFrameConf()

Ptr< SatFrameConf > ns3::SatSuperframeConf::GetFrameConf ( uint8_t  id) const

Get frame conf of the super frame.

Parameters
idId of the frame requested.
Returns
The requested frame conf of the super frame.

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

References m_frames.

◆ GetFrameCount()

uint8_t ns3::SatSuperframeConf::GetFrameCount ( ) const
inline

Get number of frames to be used in super frame.

Returns
Number of the frames in use

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

References m_frameCount.

◆ GetFrameGuardTimeSymbols()

uint8_t ns3::SatSuperframeConf::GetFrameGuardTimeSymbols ( uint8_t  frameIndex) const

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

References m_frameGuardTimeSymbols, and m_maxFrameCount.

◆ GetIndexAsFrameName()

std::string ns3::SatSuperframeConf::GetIndexAsFrameName ( uint32_t  index)
static

Method to convert frame index to frame name.

Parameters
indexindex to convert as frame name
Returns
frame name

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

References GetNumberAsString().

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SatSuperframeConf::GetInstanceTypeId ( void  ) const
virtual

Get the type ID of instance.

Returns
the object TypeId

Reimplemented in ns3::SatSuperframeConf4, ns3::SatSuperframeConf3, ns3::SatSuperframeConf2, ns3::SatSuperframeConf1, and ns3::SatSuperframeConf0.

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetLogonChannelIndex()

uint32_t ns3::SatSuperframeConf::GetLogonChannelIndex ( ) const

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

References m_logonChannelIndex.

◆ GetMaxSubdivision()

uint8_t ns3::SatSuperframeConf::GetMaxSubdivision ( ) const
inline

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

References m_maxCarrierSubdivision.

◆ GetNumberAsString()

template<class T >
static std::string ns3::SatSuperframeConf::GetNumberAsString ( T  number)
inlinestatic

Template method to convert number to string.

Parameters
numbernumber to convert as string
Returns
number as string

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

Referenced by GetIndexAsFrameName().

+ Here is the caller graph for this function:

◆ GetRaChannel()

uint8_t ns3::SatSuperframeConf::GetRaChannel ( uint32_t  carrierId) const

Get the RA channel id (index) corresponding to given (global) carrier id.

Note! In case that carrier id requested does not belong to RA frame, is O eturned.

Parameters
carrierId
Returns
RA channel id

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

References GetCarrierFrame(), and m_frames.

+ Here is the call graph for this function:

◆ GetRaChannelAllocationChannelId()

uint8_t ns3::SatSuperframeConf::GetRaChannelAllocationChannelId ( uint8_t  raChannel) const

Get RA channel allocation channel ID.

Parameters
raChannelRA channel, which allocation channel ID is requested
Returns
allocation channel ID

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

References m_raChannels.

◆ GetRaChannelCount()

uint8_t ns3::SatSuperframeConf::GetRaChannelCount ( ) const

Get the number of the RA channels in super frame configuration.

Returns
Number of the RA channels

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

References m_raChannels.

◆ GetRaChannelFrameId()

uint8_t ns3::SatSuperframeConf::GetRaChannelFrameId ( uint8_t  raChannel) const

Get RA channel frame ID.

Parameters
raChannelRA channel, which frame ID is requested
Returns
RA channel frame ID

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

References m_raChannels.

◆ GetRaChannelTimeSlotPayloadInBytes()

uint32_t ns3::SatSuperframeConf::GetRaChannelTimeSlotPayloadInBytes ( uint8_t  raChannel) const

Get the payload of the RA channel time slot in bytes.

Returns
Payload of the RA channel time slot [bytes]

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

References m_frames, and m_raChannels.

◆ GetRaSlotCount()

uint16_t ns3::SatSuperframeConf::GetRaSlotCount ( uint8_t  raChannel)

Get RA channel time slot count.

Parameters
raChannelRA channel, which slot count is requested
Returns
RA channel time slot count

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

References m_frames, and m_raChannels.

◆ GetRaSlots()

SatFrameConf::SatTimeSlotConfContainer_t ns3::SatSuperframeConf::GetRaSlots ( uint8_t  raChannel)

Get RA channel time slots.

Parameters
raChannelRA channel, which slot are requested
Returns
RA channel time slots

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

References m_frames, and m_raChannels.

◆ GetTypeId()

TypeId ns3::SatSuperframeConf::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

Referenced by GetInstanceTypeId().

+ Here is the caller graph for this function:

◆ IsFrameLogon()

bool ns3::SatSuperframeConf::IsFrameLogon ( uint8_t  frameIndex) const

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

References m_frames.

◆ IsFrameRandomAccess()

bool ns3::SatSuperframeConf::IsFrameRandomAccess ( uint8_t  frameIndex) const

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

References m_frames.

◆ IsLogonEnabled()

bool ns3::SatSuperframeConf::IsLogonEnabled ( ) const

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

References m_logonEnabled.

◆ IsRandomAccessCarrier()

bool ns3::SatSuperframeConf::IsRandomAccessCarrier ( uint32_t  carrierId) const

Check if given carrier is random access carrier.

Parameters
carrierIdId of the carrier inside super frame which is requested.
Returns
true if carrier is random access, false otherwise

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

References GetCarrierFrame(), and m_frames.

+ Here is the call graph for this function:

◆ SetConfigType()

void ns3::SatSuperframeConf::SetConfigType ( SatSuperframeConf::ConfigType_t  type)
inline

Set frame configuration type to be used in super frame.

Parameters
typeIndex of the frame configuration type

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

References m_configType.

◆ SetFrameAllocatedBandwidthHz()

void ns3::SatSuperframeConf::SetFrameAllocatedBandwidthHz ( uint8_t  frameIndex,
double  bandwidthHz 
)

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

References m_frameAllocatedBandwidth, and m_maxFrameCount.

◆ SetFrameAllocationChannelId()

void ns3::SatSuperframeConf::SetFrameAllocationChannelId ( uint8_t  frameIndex,
uint8_t  allocationChannel 
)

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

References m_frameAllocationChannel, and m_maxFrameCount.

◆ SetFrameCarrierAllocatedBandwidthHz()

void ns3::SatSuperframeConf::SetFrameCarrierAllocatedBandwidthHz ( uint8_t  frameIndex,
double  bandwidthHz 
)

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

References m_frameCarrierAllocatedBandwidth, and m_maxFrameCount.

◆ SetFrameCarrierRollOff()

void ns3::SatSuperframeConf::SetFrameCarrierRollOff ( uint8_t  frameIndex,
double  rollOff 
)

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

References m_frameCarrierRollOff, and m_maxFrameCount.

◆ SetFrameCarrierSpacing()

void ns3::SatSuperframeConf::SetFrameCarrierSpacing ( uint8_t  frameIndex,
double  spacing 
)

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

References m_frameCarrierSpacing, and m_maxFrameCount.

◆ SetFrameCarrierSpreadingFactor()

void ns3::SatSuperframeConf::SetFrameCarrierSpreadingFactor ( uint8_t  frameIndex,
uint32_t  spreadingFactor 
)

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

References m_frameCarrierSpreadingFactor, and m_maxFrameCount.

◆ SetFrameCount()

void ns3::SatSuperframeConf::SetFrameCount ( uint8_t  frameCount)
inline

Set number of frames to be used in super frame.

Parameters
frameCountNumber of the frames in use

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

References m_frameCount.

◆ SetFrameGuardTimeSymbols()

void ns3::SatSuperframeConf::SetFrameGuardTimeSymbols ( uint8_t  frameIndex,
uint8_t  guardTimeSymbols 
)

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

References m_frameGuardTimeSymbols, and m_maxFrameCount.

◆ SetFrameLogon()

void ns3::SatSuperframeConf::SetFrameLogon ( uint8_t  frameIndex,
bool  logon 
)

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

References m_frameIsLogon, and m_maxFrameCount.

◆ SetFrameRandomAccess()

void ns3::SatSuperframeConf::SetFrameRandomAccess ( uint8_t  frameIndex,
bool  randomAccess 
)

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

References m_frameIsRandomAccess, and m_maxFrameCount.

◆ SetMaxSubdivision()

void ns3::SatSuperframeConf::SetMaxSubdivision ( uint8_t  maximumCarrierSubdivision)
inline

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

References m_maxCarrierSubdivision.

Member Data Documentation

◆ m_carrierCount

uint32_t ns3::SatSuperframeConf::m_carrierCount
private

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

Referenced by AddFrameConf(), Configure(), and GetCarrierCount().

◆ m_configType

ConfigType_t ns3::SatSuperframeConf::m_configType
private

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

Referenced by Configure(), GetConfigType(), and SetConfigType().

◆ m_duration

Time ns3::SatSuperframeConf::m_duration
private

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

Referenced by Configure(), and GetDuration().

◆ m_frameAllocatedBandwidth

double ns3::SatSuperframeConf::m_frameAllocatedBandwidth[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameAllocatedBandwidthHz(), and SetFrameAllocatedBandwidthHz().

◆ m_frameAllocationChannel

uint8_t ns3::SatSuperframeConf::m_frameAllocationChannel[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameAllocationChannelId(), and SetFrameAllocationChannelId().

◆ m_frameCarrierAllocatedBandwidth

double ns3::SatSuperframeConf::m_frameCarrierAllocatedBandwidth[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameCarrierAllocatedBandwidthHz(), and SetFrameCarrierAllocatedBandwidthHz().

◆ m_frameCarrierRollOff

double ns3::SatSuperframeConf::m_frameCarrierRollOff[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameCarrierRollOff(), and SetFrameCarrierRollOff().

◆ m_frameCarrierSpacing

double ns3::SatSuperframeConf::m_frameCarrierSpacing[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameCarrierSpacing(), and SetFrameCarrierSpacing().

◆ m_frameCarrierSpreadingFactor

uint32_t ns3::SatSuperframeConf::m_frameCarrierSpreadingFactor[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameCarrierSpreadingFactor(), and SetFrameCarrierSpreadingFactor().

◆ m_frameCount

uint8_t ns3::SatSuperframeConf::m_frameCount
private

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

Referenced by Configure(), GetFrameCount(), and SetFrameCount().

◆ m_frameGuardTimeSymbols

uint8_t ns3::SatSuperframeConf::m_frameGuardTimeSymbols[m_maxFrameCount]
private

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

Referenced by Configure(), GetFrameGuardTimeSymbols(), and SetFrameGuardTimeSymbols().

◆ m_frameIsLogon

bool ns3::SatSuperframeConf::m_frameIsLogon[m_maxFrameCount]
private

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

Referenced by Configure(), and SetFrameLogon().

◆ m_frameIsRandomAccess

bool ns3::SatSuperframeConf::m_frameIsRandomAccess[m_maxFrameCount]
private

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

Referenced by Configure(), and SetFrameRandomAccess().

◆ m_frames

SatFrameConfList_t ns3::SatSuperframeConf::m_frames
private

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

Referenced by AddFrameConf(), Configure(), GetCarrierBandwidthHz(), GetCarrierFrame(), GetCarrierFrameConf(), GetCarrierFrequencyHz(), GetCarrierId(), GetFrameConf(), GetRaChannel(), GetRaChannelTimeSlotPayloadInBytes(), GetRaSlotCount(), GetRaSlots(), IsFrameLogon(), IsFrameRandomAccess(), and IsRandomAccessCarrier().

◆ m_logonChannelIndex

uint32_t ns3::SatSuperframeConf::m_logonChannelIndex
private

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

Referenced by AddFrameConf(), and GetLogonChannelIndex().

◆ m_logonEnabled

bool ns3::SatSuperframeConf::m_logonEnabled
private

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

Referenced by AddFrameConf(), and IsLogonEnabled().

◆ m_maxCarrierSubdivision

uint8_t ns3::SatSuperframeConf::m_maxCarrierSubdivision
private

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

Referenced by Configure(), GetMaxSubdivision(), and SetMaxSubdivision().

◆ m_maxFrameCount

const uint8_t ns3::SatSuperframeConf::m_maxFrameCount = 10
static

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

Referenced by GetFrameAllocatedBandwidthHz(), GetFrameAllocationChannelId(), GetFrameCarrierAllocatedBandwidthHz(), GetFrameCarrierRollOff(), GetFrameCarrierSpacing(), GetFrameCarrierSpreadingFactor(), GetFrameGuardTimeSymbols(), SetFrameAllocatedBandwidthHz(), SetFrameAllocationChannelId(), SetFrameCarrierAllocatedBandwidthHz(), SetFrameCarrierRollOff(), SetFrameCarrierSpacing(), SetFrameCarrierSpreadingFactor(), SetFrameGuardTimeSymbols(), SetFrameLogon(), and SetFrameRandomAccess().

◆ m_raChannels

std::vector<RaChannelInfo_t> ns3::SatSuperframeConf::m_raChannels
private

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

Referenced by AddFrameConf(), Configure(), GetRaChannelAllocationChannelId(), GetRaChannelCount(), GetRaChannelFrameId(), GetRaChannelTimeSlotPayloadInBytes(), GetRaSlotCount(), and GetRaSlots().

◆ m_usedBandwidthHz

double ns3::SatSuperframeConf::m_usedBandwidthHz
private

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

Referenced by Configure(), and GetBandwidthHz().

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