Loading...
Searching...
No Matches
ns3::SatSuperframeConf2 Class Reference

This class implements sup. More...

#include "satellite-frame-conf.h"

Inheritance diagram for ns3::SatSuperframeConf2:
Collaboration diagram for ns3::SatSuperframeConf2:

Public Member Functions

 SatSuperframeConf2 ()
 Default constructor for SatSuperframeConf.
 ~SatSuperframeConf2 ()
 Destructor for SatSuperframeConf.
virtual void DoConfigure ()
 Do frame specific configuration as needed.
Public Member Functions inherited from ns3::SatSuperframeConf
 SatSuperframeConf ()
 Default constructor for SatSuperframeConf.
 ~SatSuperframeConf ()
 Destructor for SatSuperframeConf.
void Configure (double allocatedBandwidthHz, Time targetDuration, Ptr< SatWaveformConf > waveformConf)
 Configures super frame configuration according to set attributes.
 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.
double GetCarrierBandwidthHz (uint32_t carrierId, SatEnums::CarrierBandwidthType_t bandwidthType) const
 Get the bandwidth of the requested carrier.
uint32_t GetCarrierCount () const
 Get carrier count in the super frame.
Ptr< SatFrameConf > GetCarrierFrameConf (uint32_t carrierId) const
 Get the frame configuration of the requested carrier.
double GetCarrierFrequencyHz (uint32_t carrierId) const
 Get the center frequency of the requested carrier.
uint32_t GetCarrierId (uint8_t frameId, uint16_t frameCarrierId) const
 Get carrier id of the super frame.
SatSuperframeConf::ConfigType_t GetConfigType () const
 Get frame configuration type to be used in super frame.
Time GetDuration () const
 Get duration of super frame.
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.
uint8_t GetFrameCount () const
 Get number of frames to be used in super frame.
uint8_t GetFrameGuardTimeSymbols (uint8_t frameIndex) const
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.
uint8_t GetRaChannelAllocationChannelId (uint8_t raChannel) const
 Get RA channel allocation channel ID.
uint8_t GetRaChannelCount () const
 Get the number of the RA channels in super frame configuration.
uint8_t GetRaChannelFrameId (uint8_t raChannel) const
 Get RA channel frame ID.
uint32_t GetRaChannelTimeSlotPayloadInBytes (uint8_t raChannel) const
 Get the payload of the RA channel time slot in bytes.
uint16_t GetRaSlotCount (uint8_t raChannel)
 Get RA channel time slot count.
SatFrameConf::SatTimeSlotConfContainer_t GetRaSlots (uint8_t raChannel)
 Get RA channel time slots.
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.
void SetConfigType (SatSuperframeConf::ConfigType_t type)
 Set frame configuration type to be used in super frame.
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.
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 TypeId GetTypeId (void)
 Get the type ID.
Static Public Member Functions inherited from ns3::SatSuperframeConf
static Ptr< SatSuperframeConf > CreateSuperframeConf (SuperFrameConfiguration_t conf)
 Create pre-configured super frame configuration-.
static std::string GetIndexAsFrameName (uint32_t index)
 Method to convert frame index to frame name.
template<class T>
static std::string GetNumberAsString (T number)
 Template method to convert number to string.
static TypeId GetTypeId (void)
 Get the type ID.

Additional Inherited Members

Public Types inherited from ns3::SatSuperframeConf
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.
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...
Static Public Attributes inherited from ns3::SatSuperframeConf
static const uint8_t m_maxFrameCount = 10

Detailed Description

This class implements sup.

/ns3/satellite-frame-conf.h: In member function ‘double ns3::SatSuperframeConf::GetFrame0RandomAccess() const’: er frame configuration 2

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

Constructor & Destructor Documentation

◆ SatSuperframeConf2()

ns3::SatSuperframeConf2::SatSuperframeConf2 ( )

Default constructor for SatSuperframeConf.

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

◆ ~SatSuperframeConf2()

ns3::SatSuperframeConf2::~SatSuperframeConf2 ( )

Destructor for SatSuperframeConf.

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

Member Function Documentation

◆ DoConfigure()

void ns3::SatSuperframeConf2::DoConfigure ( )
virtual

Do frame specific configuration as needed.

Implements ns3::SatSuperframeConf.

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

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References ADD_FRAME_ATTRIBUTES, ADD_SUPER_FRAME_ATTRIBUTES, and ns3::SatSuperframeConf::CONFIG_TYPE_2.

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