ns3::SatSuperframeConf0 Class Reference
This class implements super frame configuration 0. More...
#include "satellite-frame-conf.h"
Inheritance diagram for ns3::SatSuperframeConf0:
Collaboration diagram for ns3::SatSuperframeConf0:
Public Member Functions | |
| SatSuperframeConf0 () | |
| Default constructor for SatSuperframeConf. More... | |
| ~SatSuperframeConf0 () | |
| Destructor for SatSuperframeConf. More... | |
| virtual void | DoConfigure () |
| Do frame specific configuration as needed. More... | |
| virtual TypeId | GetInstanceTypeId (void) const |
| Get the type ID of instance. More... | |
| Public Member Functions inherited from ns3::SatSuperframeConf | |
| 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... | |
| 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 |
| 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 TypeId | GetTypeId (void) |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::SatSuperframeConf | |
| 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... | |
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. 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... | |
| Static Public Attributes inherited from ns3::SatSuperframeConf | |
| static const uint8_t | m_maxFrameCount = 10 |
Detailed Description
This class implements super frame configuration 0.
Definition at line 970 of file satellite-frame-conf.h.
Constructor & Destructor Documentation
◆ SatSuperframeConf0()
| ns3::SatSuperframeConf0::SatSuperframeConf0 | ( | ) |
Default constructor for SatSuperframeConf.
Definition at line 1291 of file satellite-frame-conf.cc.
◆ ~SatSuperframeConf0()
| ns3::SatSuperframeConf0::~SatSuperframeConf0 | ( | ) |
Destructor for SatSuperframeConf.
Definition at line 1296 of file satellite-frame-conf.cc.
Member Function Documentation
◆ DoConfigure()
|
virtual |
Do frame specific configuration as needed.
Implements ns3::SatSuperframeConf.
Definition at line 1383 of file satellite-frame-conf.cc.
◆ GetInstanceTypeId()
|
virtual |
Get the type ID of instance.
- Returns
- the object TypeId
Reimplemented from ns3::SatSuperframeConf.
Definition at line 1376 of file satellite-frame-conf.cc.
References GetTypeId().
Here is the call graph for this function:
◆ GetTypeId()
|
static |
Get the type ID.
- Returns
- the object TypeId
Definition at line 1302 of file satellite-frame-conf.cc.
References ADD_FRAME_ATTRIBUTES, ADD_SUPER_FRAME_ATTRIBUTES, and ns3::SatSuperframeConf::CONFIG_TYPE_0.
Referenced by GetInstanceTypeId().
Here is the caller graph for this function:
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
