A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::SSRecord Class Reference
WiMAX Models

This class is used by the base station to store some information related to subscriber station in the cell. More...

#include <ss-record.h>

+ Collaboration diagram for ns3::SSRecord:

Public Member Functions

 SSRecord (void)
 
 SSRecord (Mac48Address macAddress)
 
 SSRecord (Mac48Address macAddress, Ipv4Address IPaddress)
 
 ~SSRecord (void)
 
void AddServiceFlow (ServiceFlow *serviceFlow)
 
void DisablePollForRanging (void)
 
void EnablePollForRanging (void)
 
bool GetAreServiceFlowsAllocated (void) const
 
Cid GetBasicCid (void) const
 
DsaRsp GetDsaRsp (void) const
 
uint8_t GetDsaRspRetries (void) const
 
bool GetHasServiceFlowBe (void) const
 
bool GetHasServiceFlowNrtps (void) const
 
bool GetHasServiceFlowRtps (void) const
 
bool GetHasServiceFlowUgs (void) const
 
uint8_t GetInvitedRangRetries (void) const
 
Ipv4Address GetIPAddress (void)
 
bool GetIsBroadcastSS (void)
 
Mac48Address GetMacAddress (void) const
 
WimaxPhy::ModulationType GetModulationType (void) const
 
bool GetPollForRanging (void) const
 
bool GetPollMeBit (void) const
 
Cid GetPrimaryCid (void) const
 
uint8_t GetRangingCorrectionRetries (void) const
 
WimaxNetDevice::RangingStatus GetRangingStatus (void) const
 
std::vector< ServiceFlow * > GetServiceFlows (enum ServiceFlow::SchedulingType schedulingType) const
 
uint16_t GetSfTransactionId (void) const
 
void IncrementDsaRspRetries (void)
 
void IncrementInvitedRangingRetries (void)
 
void IncrementRangingCorrectionRetries (void)
 
void ResetInvitedRangingRetries (void)
 
void ResetRangingCorrectionRetries (void)
 
void SetAreServiceFlowsAllocated (bool val)
 
void SetBasicCid (Cid basicCid)
 
void SetDsaRsp (DsaRsp dsaRsp)
 
void SetDsaRspRetries (uint8_t dsaRspRetries)
 
void SetIPAddress (Ipv4Address IPaddress)
 
void SetIsBroadcastSS (bool)
 
void SetMacAddress (Mac48Address macAddress)
 
void SetModulationType (WimaxPhy::ModulationType modulationType)
 
void SetPollMeBit (bool pollMeBit)
 
void SetPrimaryCid (Cid primaryCid)
 
void SetRangingStatus (WimaxNetDevice::RangingStatus rangingStatus)
 
void SetSfTransactionId (uint16_t sfTransactionId)
 

Private Member Functions

void Initialize (void)
 

Private Attributes

bool m_areServiceFlowsAllocated
 
Cid m_basicCid
 
bool m_broadcast
 
DsaRsp m_dsaRsp
 
uint8_t m_dsaRspRetries
 
uint8_t m_invitedRangingRetries
 
Ipv4Address m_IPAddress
 
Mac48Address m_macAddress
 
WimaxPhy::ModulationType m_modulationType
 
bool m_pollForRanging
 
bool m_pollMeBit
 
Cid m_primaryCid
 
uint8_t m_rangingCorrectionRetries
 
WimaxNetDevice::RangingStatus m_rangingStatus
 
std::vector< ServiceFlow * > * m_serviceFlows
 
uint16_t m_sfTransactionId
 

Detailed Description

This class is used by the base station to store some information related to subscriber station in the cell.

Definition at line 43 of file ss-record.h.

Constructor & Destructor Documentation

ns3::SSRecord::SSRecord ( void  )

Definition at line 28 of file ss-record.cc.

References Initialize().

+ Here is the call graph for this function:

ns3::SSRecord::SSRecord ( Mac48Address  macAddress)

Definition at line 33 of file ss-record.cc.

References Initialize(), and m_macAddress.

+ Here is the call graph for this function:

ns3::SSRecord::SSRecord ( Mac48Address  macAddress,
Ipv4Address  IPaddress 
)

Definition at line 39 of file ss-record.cc.

References Initialize(), m_IPAddress, and m_macAddress.

+ Here is the call graph for this function:

ns3::SSRecord::~SSRecord ( void  )

Definition at line 68 of file ss-record.cc.

References m_serviceFlows.

Member Function Documentation

void ns3::SSRecord::AddServiceFlow ( ServiceFlow *  serviceFlow)

Definition at line 224 of file ss-record.cc.

References m_serviceFlows.

void ns3::SSRecord::DisablePollForRanging ( void  )

Definition at line 188 of file ss-record.cc.

References m_pollForRanging.

Referenced by ns3::BSLinkManager::AbortRanging(), and ns3::BSLinkManager::AcceptRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::EnablePollForRanging ( void  )

Definition at line 182 of file ss-record.cc.

References m_pollForRanging.

Referenced by ns3::BSLinkManager::PerformInitialRanging().

+ Here is the caller graph for this function:

bool ns3::SSRecord::GetAreServiceFlowsAllocated ( void  ) const

Definition at line 206 of file ss-record.cc.

References m_areServiceFlowsAllocated.

Referenced by ns3::UplinkSchedulerSimple::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerMBQoS::Schedule(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

Cid ns3::SSRecord::GetBasicCid ( void  ) const

Definition at line 92 of file ss-record.cc.

References m_basicCid.

Referenced by ns3::SSManager::DeleteSSRecord(), ns3::SSManager::GetSSRecord(), ns3::BSLinkManager::PerformInitialRanging(), ns3::UplinkSchedulerSimple::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerMBQoS::Schedule(), ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection(), and ns3::BSLinkManager::VerifyInvitedRanging().

+ Here is the caller graph for this function:

DsaRsp ns3::SSRecord::GetDsaRsp ( void  ) const

Definition at line 342 of file ss-record.cc.

References m_dsaRsp.

uint8_t ns3::SSRecord::GetDsaRspRetries ( void  ) const

Definition at line 330 of file ss-record.cc.

References m_dsaRspRetries.

bool ns3::SSRecord::GetHasServiceFlowBe ( void  ) const

Definition at line 294 of file ss-record.cc.

References m_serviceFlows, and ns3::ServiceFlow::SF_TYPE_BE.

Referenced by ns3::UplinkSchedulerMBQoS::Schedule().

+ Here is the caller graph for this function:

bool ns3::SSRecord::GetHasServiceFlowNrtps ( void  ) const

Definition at line 281 of file ss-record.cc.

References m_serviceFlows, and ns3::ServiceFlow::SF_TYPE_NRTPS.

Referenced by ns3::UplinkSchedulerMBQoS::Schedule().

+ Here is the caller graph for this function:

bool ns3::SSRecord::GetHasServiceFlowRtps ( void  ) const

Definition at line 268 of file ss-record.cc.

References m_serviceFlows, and ns3::ServiceFlow::SF_TYPE_RTPS.

Referenced by ns3::UplinkSchedulerMBQoS::Schedule().

+ Here is the caller graph for this function:

bool ns3::SSRecord::GetHasServiceFlowUgs ( void  ) const

Definition at line 255 of file ss-record.cc.

References m_serviceFlows, and ns3::ServiceFlow::SF_TYPE_UGS.

Referenced by ns3::BandwidthManager::CalculateAllocationSize(), and ns3::UplinkSchedulerMBQoS::Schedule().

+ Here is the caller graph for this function:

uint8_t ns3::SSRecord::GetInvitedRangRetries ( void  ) const

Definition at line 140 of file ss-record.cc.

References m_invitedRangingRetries.

Referenced by ns3::BSLinkManager::VerifyInvitedRanging().

+ Here is the caller graph for this function:

Ipv4Address ns3::SSRecord::GetIPAddress ( void  )

Definition at line 80 of file ss-record.cc.

References m_IPAddress.

bool ns3::SSRecord::GetIsBroadcastSS ( void  )

Definition at line 249 of file ss-record.cc.

References m_broadcast.

Referenced by ns3::UplinkSchedulerSimple::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerMBQoS::Schedule(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

Mac48Address ns3::SSRecord::GetMacAddress ( void  ) const

Definition at line 116 of file ss-record.cc.

References m_macAddress.

Referenced by ns3::SSManager::GetMacAddress(), and ns3::UplinkSchedulerMBQoS::ProcessBandwidthRequest().

+ Here is the caller graph for this function:

WimaxPhy::ModulationType ns3::SSRecord::GetModulationType ( void  ) const

Definition at line 164 of file ss-record.cc.

References m_modulationType.

Referenced by ns3::UplinkSchedulerMBQoS::CountSymbolsJobs(), ns3::UplinkSchedulerSimple::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerMBQoS::Schedule(), ns3::UplinkSchedulerSimple::SetupServiceFlow(), ns3::UplinkSchedulerMBQoS::SetupServiceFlow(), ns3::UplinkSchedulerRtps::SetupServiceFlow(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

bool ns3::SSRecord::GetPollForRanging ( void  ) const

Definition at line 194 of file ss-record.cc.

References m_pollForRanging.

Referenced by ns3::UplinkSchedulerSimple::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerMBQoS::Schedule(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

bool ns3::SSRecord::GetPollMeBit ( void  ) const

Definition at line 218 of file ss-record.cc.

References m_pollMeBit.

Referenced by ns3::BandwidthManager::CalculateAllocationSize().

+ Here is the caller graph for this function:

Cid ns3::SSRecord::GetPrimaryCid ( void  ) const

Definition at line 104 of file ss-record.cc.

References m_primaryCid.

Referenced by ns3::SSManager::DeleteSSRecord(), and ns3::SSManager::GetSSRecord().

+ Here is the caller graph for this function:

uint8_t ns3::SSRecord::GetRangingCorrectionRetries ( void  ) const

Definition at line 122 of file ss-record.cc.

References m_rangingCorrectionRetries.

Referenced by ns3::BSLinkManager::PerformInvitedRanging().

+ Here is the caller graph for this function:

WimaxNetDevice::RangingStatus ns3::SSRecord::GetRangingStatus ( void  ) const

Definition at line 176 of file ss-record.cc.

References m_rangingStatus.

Referenced by ns3::SSManager::IsRegistered(), ns3::UplinkSchedulerSimple::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerMBQoS::Schedule(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

std::vector< ServiceFlow * > ns3::SSRecord::GetServiceFlows ( enum ServiceFlow::SchedulingType  schedulingType) const

Definition at line 229 of file ss-record.cc.

References m_serviceFlows, and ns3::ServiceFlow::SF_TYPE_ALL.

Referenced by ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth(), ns3::UplinkSchedulerMBQoS::CreateUlJob(), ns3::SSManager::DeleteSSRecord(), ns3::SSManager::GetSSRecord(), ns3::UplinkSchedulerMBQoS::Schedule(), ns3::UplinkSchedulerSimple::ServiceBandwidthRequests(), ns3::UplinkSchedulerRtps::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants(), ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants(), ns3::UplinkSchedulerMBQoS::ServiceUnsolicitedGrants(), ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection(), and ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

+ Here is the caller graph for this function:

uint16_t ns3::SSRecord::GetSfTransactionId ( void  ) const

Definition at line 312 of file ss-record.cc.

References m_sfTransactionId.

void ns3::SSRecord::IncrementDsaRspRetries ( void  )

Definition at line 324 of file ss-record.cc.

References m_dsaRspRetries.

void ns3::SSRecord::IncrementInvitedRangingRetries ( void  )

Definition at line 152 of file ss-record.cc.

References m_invitedRangingRetries.

Referenced by ns3::BSLinkManager::VerifyInvitedRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::IncrementRangingCorrectionRetries ( void  )

Definition at line 134 of file ss-record.cc.

References m_rangingCorrectionRetries.

Referenced by ns3::BSLinkManager::PerformInvitedRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::Initialize ( void  )
private

Definition at line 47 of file ss-record.cc.

References m_areServiceFlowsAllocated, m_basicCid, m_broadcast, m_dsaRsp, m_dsaRspRetries, m_invitedRangingRetries, m_modulationType, m_pollForRanging, m_pollMeBit, m_primaryCid, m_rangingCorrectionRetries, m_rangingStatus, m_serviceFlows, m_sfTransactionId, ns3::WimaxPhy::MODULATION_TYPE_BPSK_12, and ns3::WimaxNetDevice::RANGING_STATUS_EXPIRED.

Referenced by SSRecord().

+ Here is the caller graph for this function:

void ns3::SSRecord::ResetInvitedRangingRetries ( void  )

Definition at line 146 of file ss-record.cc.

References m_invitedRangingRetries.

Referenced by ns3::BSLinkManager::PerformInitialRanging(), and ns3::BSLinkManager::PerformInvitedRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::ResetRangingCorrectionRetries ( void  )

Definition at line 128 of file ss-record.cc.

References m_rangingCorrectionRetries.

Referenced by ns3::BSLinkManager::PerformInitialRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::SetAreServiceFlowsAllocated ( bool  val)

Definition at line 200 of file ss-record.cc.

References m_areServiceFlowsAllocated.

void ns3::SSRecord::SetBasicCid ( Cid  basicCid)

Definition at line 86 of file ss-record.cc.

References m_basicCid.

Referenced by ns3::ConnectionManager::AllocateManagementConnections().

+ Here is the caller graph for this function:

void ns3::SSRecord::SetDsaRsp ( DsaRsp  dsaRsp)

Definition at line 336 of file ss-record.cc.

References m_dsaRsp.

void ns3::SSRecord::SetDsaRspRetries ( uint8_t  dsaRspRetries)

Definition at line 318 of file ss-record.cc.

References m_dsaRspRetries.

void ns3::SSRecord::SetIPAddress ( Ipv4Address  IPaddress)

Definition at line 75 of file ss-record.cc.

References m_IPAddress.

void ns3::SSRecord::SetIsBroadcastSS ( bool  broadcast_enable)

Definition at line 243 of file ss-record.cc.

References m_broadcast.

void ns3::SSRecord::SetMacAddress ( Mac48Address  macAddress)

Definition at line 110 of file ss-record.cc.

References m_macAddress.

void ns3::SSRecord::SetModulationType ( WimaxPhy::ModulationType  modulationType)

Definition at line 158 of file ss-record.cc.

References m_modulationType.

Referenced by ns3::BSLinkManager::PerformInitialRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::SetPollMeBit ( bool  pollMeBit)

Definition at line 212 of file ss-record.cc.

References m_pollMeBit.

void ns3::SSRecord::SetPrimaryCid ( Cid  primaryCid)

Definition at line 98 of file ss-record.cc.

References m_primaryCid.

Referenced by ns3::ConnectionManager::AllocateManagementConnections().

+ Here is the caller graph for this function:

void ns3::SSRecord::SetRangingStatus ( WimaxNetDevice::RangingStatus  rangingStatus)

Definition at line 170 of file ss-record.cc.

References m_rangingStatus.

Referenced by ns3::BSLinkManager::AbortRanging(), ns3::BSLinkManager::AcceptRanging(), and ns3::BSLinkManager::ContinueRanging().

+ Here is the caller graph for this function:

void ns3::SSRecord::SetSfTransactionId ( uint16_t  sfTransactionId)

Definition at line 307 of file ss-record.cc.

References m_sfTransactionId.

Member Data Documentation

bool ns3::SSRecord::m_areServiceFlowsAllocated
private

Definition at line 118 of file ss-record.h.

Referenced by GetAreServiceFlowsAllocated(), Initialize(), and SetAreServiceFlowsAllocated().

Cid ns3::SSRecord::m_basicCid
private

Definition at line 109 of file ss-record.h.

Referenced by GetBasicCid(), Initialize(), and SetBasicCid().

bool ns3::SSRecord::m_broadcast
private

Definition at line 120 of file ss-record.h.

Referenced by GetIsBroadcastSS(), Initialize(), and SetIsBroadcastSS().

DsaRsp ns3::SSRecord::m_dsaRsp
private

Definition at line 127 of file ss-record.h.

Referenced by GetDsaRsp(), Initialize(), and SetDsaRsp().

uint8_t ns3::SSRecord::m_dsaRspRetries
private

Definition at line 126 of file ss-record.h.

Referenced by GetDsaRspRetries(), IncrementDsaRspRetries(), Initialize(), and SetDsaRspRetries().

uint8_t ns3::SSRecord::m_invitedRangingRetries
private

Definition at line 113 of file ss-record.h.

Referenced by GetInvitedRangRetries(), IncrementInvitedRangingRetries(), Initialize(), and ResetInvitedRangingRetries().

Ipv4Address ns3::SSRecord::m_IPAddress
private

Definition at line 107 of file ss-record.h.

Referenced by GetIPAddress(), SetIPAddress(), and SSRecord().

Mac48Address ns3::SSRecord::m_macAddress
private

Definition at line 106 of file ss-record.h.

Referenced by GetMacAddress(), SetMacAddress(), and SSRecord().

WimaxPhy::ModulationType ns3::SSRecord::m_modulationType
private

Definition at line 115 of file ss-record.h.

Referenced by GetModulationType(), Initialize(), and SetModulationType().

bool ns3::SSRecord::m_pollForRanging
private

Definition at line 117 of file ss-record.h.

Referenced by DisablePollForRanging(), EnablePollForRanging(), GetPollForRanging(), and Initialize().

bool ns3::SSRecord::m_pollMeBit
private

Definition at line 119 of file ss-record.h.

Referenced by GetPollMeBit(), Initialize(), and SetPollMeBit().

Cid ns3::SSRecord::m_primaryCid
private

Definition at line 110 of file ss-record.h.

Referenced by GetPrimaryCid(), Initialize(), and SetPrimaryCid().

uint8_t ns3::SSRecord::m_rangingCorrectionRetries
private

Definition at line 112 of file ss-record.h.

Referenced by GetRangingCorrectionRetries(), IncrementRangingCorrectionRetries(), Initialize(), and ResetRangingCorrectionRetries().

WimaxNetDevice::RangingStatus ns3::SSRecord::m_rangingStatus
private

Definition at line 116 of file ss-record.h.

Referenced by GetRangingStatus(), Initialize(), and SetRangingStatus().

std::vector<ServiceFlow*>* ns3::SSRecord::m_serviceFlows
private

Definition at line 122 of file ss-record.h.

Referenced by AddServiceFlow(), GetHasServiceFlowBe(), GetHasServiceFlowNrtps(), GetHasServiceFlowRtps(), GetHasServiceFlowUgs(), GetServiceFlows(), Initialize(), and ~SSRecord().

uint16_t ns3::SSRecord::m_sfTransactionId
private

Definition at line 125 of file ss-record.h.

Referenced by GetSfTransactionId(), Initialize(), and SetSfTransactionId().

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