A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::SubscriberStationNetDevice Class Reference

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::SubscriberStationNetDevice:

Public Types

enum  EventType {
  EVENT_NONE, EVENT_WAIT_FOR_RNG_RSP, EVENT_DL_MAP_SYNC_TIMEOUT, EVENT_LOST_DL_MAP,
  EVENT_LOST_UL_MAP, EVENT_DCD_WAIT_TIMEOUT, EVENT_UCD_WAIT_TIMEOUT, EVENT_RANG_OPP_WAIT_TIMEOUT
}
 
enum  State {
  SS_STATE_IDLE, SS_STATE_SCANNING, SS_STATE_SYNCHRONIZING, SS_STATE_ACQUIRING_PARAMETERS,
  SS_STATE_WAITING_REG_RANG_INTRVL, SS_STATE_WAITING_INV_RANG_INTRVL, SS_STATE_WAITING_RNG_RSP, SS_STATE_ADJUSTING_PARAMETERS,
  SS_STATE_REGISTERED, SS_STATE_TRANSMITTING, SS_STATE_STOPPED
}
 
- Public Types inherited from ns3::WimaxNetDevice
enum  Direction { DIRECTION_DOWNLINK, DIRECTION_UPLINK }
 
enum  RangingStatus { RANGING_STATUS_EXPIRED, RANGING_STATUS_CONTINUE, RANGING_STATUS_ABORT, RANGING_STATUS_SUCCESS }
 
- Public Types inherited from ns3::NetDevice
enum  PacketType {
  PACKET_HOST = 1, NS3_PACKET_HOST = PACKET_HOST, PACKET_BROADCAST, NS3_PACKET_BROADCAST = PACKET_BROADCAST,
  PACKET_MULTICAST, NS3_PACKET_MULTICAST = PACKET_MULTICAST, PACKET_OTHERHOST, NS3_PACKET_OTHERHOST = PACKET_OTHERHOST
}
 
typedef Callback< bool, Ptr
< NetDevice >, Ptr< const
Packet >, uint16_t, const
Address &, const Address
&, enum PacketType
PromiscReceiveCallback
 
typedef Callback< bool, Ptr
< NetDevice >, Ptr< const
Packet >, uint16_t, const
Address & > 
ReceiveCallback
 

Public Member Functions

 SubscriberStationNetDevice (Ptr< Node >, Ptr< WimaxPhy >)
 
void AddServiceFlow (ServiceFlow *sf)
 adds a new service flow
 
void AddServiceFlow (ServiceFlow sf)
 adds a new service flow
 
bool Enqueue (Ptr< Packet > packet, const MacHeaderType &hdrType, Ptr< WimaxConnection > connection)
 Enqueue a packet into a connection queue. More...
 
bool GetAreManagementConnectionsAllocated (void) const
 
bool GetAreServiceFlowsAllocated (void) const
 
Cid GetBasicCid (void) const
 
Ptr< WimaxConnectionGetBasicConnection (void) const
 
Time GetIntervalT1 (void) const
 
Time GetIntervalT12 (void) const
 
Time GetIntervalT2 (void) const
 
Time GetIntervalT20 (void) const
 
Time GetIntervalT21 (void) const
 
Time GetIntervalT3 (void) const
 
Time GetIntervalT7 (void) const
 
Ptr< IpcsClassifierGetIpcsClassifier () const
 
Ptr< SSLinkManagerGetLinkManager (void) const
 
Time GetLostDlMapInterval (void) const
 
Time GetLostUlMapInterval (void) const
 
uint8_t GetMaxContentionRangingRetries (void) const
 
Time GetMaxDcdInterval (void) const
 
Time GetMaxUcdInterval (void) const
 
WimaxPhy::ModulationType GetModulationType (void) const
 
Cid GetPrimaryCid (void) const
 
Ptr< WimaxConnectionGetPrimaryConnection (void) const
 
Ptr< SSSchedulerGetScheduler (void) const
 
Ptr< SsServiceFlowManagerGetServiceFlowManager (void) const
 
Time GetTimeToAllocation (Time defferTime)
 
bool HasServiceFlows (void) const
 
void InitSubscriberStationNetDevice (void)
 initializes the net device and sets the parameters to the default values
 
bool IsRegistered (void) const
 
void SendBurst (uint8_t uiuc, uint16_t nrSymbols, Ptr< WimaxConnection > connection, MacHeaderType::HeaderType packetType=MacHeaderType::HEADER_TYPE_GENERIC)
 Sends a burst on the uplink frame.
 
void SetAreManagementConnectionsAllocated (bool areManagementConnectionsAllocated)
 
void SetAreServiceFlowsAllocated (bool areServiceFlowsAllocated)
 
void SetBasicConnection (Ptr< WimaxConnection > basicConnection)
 
void SetIntervalT1 (Time interval1)
 
void SetIntervalT12 (Time interval12)
 
void SetIntervalT2 (Time interval2)
 
void SetIntervalT20 (Time interval20)
 
void SetIntervalT21 (Time interval21)
 
void SetIntervalT3 (Time interval3)
 
void SetIntervalT7 (Time interval7)
 
void SetIpcsPacketClassifier (Ptr< IpcsClassifier >)
 Sets the packet classifier to be used.
 
void SetLinkManager (Ptr< SSLinkManager >)
 sets the link manager to be used
 
void SetLostDlMapInterval (Time lostDlMapInterval)
 
void SetLostUlMapInterval (Time lostUlMapInterval)
 
void SetMaxContentionRangingRetries (uint8_t maxContentionRangingRetries)
 
void SetMaxDcdInterval (Time maxDcdInterval)
 
void SetMaxUcdInterval (Time maxUcdInterval)
 
void SetModulationType (WimaxPhy::ModulationType modulationType)
 Set the most efficient modulation and coding scheme (MCS) supported by the device. More...
 
void SetPrimaryConnection (Ptr< WimaxConnection > primaryConnection)
 
void SetScheduler (Ptr< SSScheduler > ssScheduler)
 
void SetServiceFlowManager (Ptr< SsServiceFlowManager >)
 Sets the service flow manager to be installed on the device.
 
void SetTimer (EventId eventId, EventId &event)
 
void Start (void)
 
void Stop (void)
 
- Public Member Functions inherited from ns3::WimaxNetDevice
virtual void AddLinkChangeCallback (Callback< void > callback)
 
void Attach (Ptr< WimaxChannel > channel)
 
void CreateDefaultConnections (void)
 
void ForwardDown (Ptr< PacketBurst > burst, WimaxPhy::ModulationType modulationType)
 
void ForwardUp (Ptr< Packet > packet, const Mac48Address &source, const Mac48Address &dest)
 
virtual Address GetAddress (void) const
 
Ptr< BandwidthManagerGetBandwidthManager (void) const
 
virtual Address GetBroadcast (void) const
 
Ptr< WimaxConnectionGetBroadcastConnection (void) const
 
Ptr< BurstProfileManagerGetBurstProfileManager (void) const
 
uint64_t GetChannel (uint8_t index) const
 
virtual Ptr< ChannelGetChannel (void) const
 
Ptr< ConnectionManagerGetConnectionManager (void) const
 
Dcd GetCurrentDcd (void) const
 
Ucd GetCurrentUcd (void) const
 
virtual uint32_t GetIfIndex (void) const
 
Ptr< WimaxConnectionGetInitialRangingConnection (void) const
 
Mac48Address GetMacAddress (void) const
 
virtual uint16_t GetMtu (void) const
 
virtual Address GetMulticast (void) const
 
virtual Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided. More...
 
virtual Address GetMulticast (Ipv4Address multicastGroup) const
 Make and return a MAC multicast address using the provided multicast group. More...
 
virtual std::string GetName (void) const
 
virtual Ptr< NodeGetNode (void) const
 
uint32_t GetNrFrames (void) const
 
Ptr< WimaxPhyGetPhy (void) const
 
virtual Ptr< ChannelGetPhyChannel (void) const
 
NetDevice::PromiscReceiveCallback GetPromiscReceiveCallback (void)
 
uint16_t GetRtg (void) const
 
uint8_t GetState (void) const
 
uint16_t GetTtg (void) const
 
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge. More...
 
virtual bool IsBroadcast (void) const
 
virtual bool IsLinkUp (void) const
 
virtual bool IsMulticast (void) const
 
virtual bool IsPointToPoint (void) const
 Return true if the net device is on a point-to-point link. More...
 
bool IsPromisc (void)
 
virtual Address MakeMulticastAddress (Ipv4Address multicastGroup) const
 
virtual bool NeedsArp (void) const
 
void NotifyPromiscTrace (Ptr< Packet > p)
 
virtual bool Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
 
virtual bool SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
 
virtual void SetAddress (Address address)
 
void SetBandwidthManager (Ptr< BandwidthManager > bandwidthManager)
 
void SetBurstProfileManager (Ptr< BurstProfileManager > burstProfileManager)
 
void SetChannel (Ptr< WimaxChannel > wimaxChannel)
 
virtual void SetConnectionManager (Ptr< ConnectionManager > connectionManager)
 
void SetCurrentDcd (Dcd dcd)
 
void SetCurrentUcd (Ucd ucd)
 
virtual void SetIfIndex (const uint32_t index)
 
virtual void SetLinkChangeCallback (Callback< void > callback)
 
void SetMacAddress (Mac48Address address)
 
virtual bool SetMtu (const uint16_t mtu)
 
virtual void SetName (const std::string name)
 
virtual void SetNode (Ptr< Node > node)
 
void SetNrFrames (uint32_t nrFrames)
 
void SetPhy (Ptr< WimaxPhy > phy)
 
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)
 
void SetReceiveCallback (void)
 
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
 
void SetRtg (uint16_t rtg)
 
void SetState (uint8_t state)
 
void SetTtg (uint16_t ttg)
 
virtual bool SupportsSendFrom (void) const
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::WimaxNetDevice
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::NetDevice
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Public Attributes

Ptr< SSLinkManagerm_linkManager
 
- Public Attributes inherited from ns3::WimaxNetDevice
TracedCallback< Ptr< const
Packet >, const Mac48Address & > 
m_traceRx
 
TracedCallback< Ptr< const
Packet >, const Mac48Address & > 
m_traceTx
 

Private Member Functions

void DoDispose (void)
 
void DoReceive (Ptr< Packet > packet)
 
bool DoSend (Ptr< Packet > packet, const Mac48Address &source, const Mac48Address &dest, uint16_t protocolNumber)
 
void ProcessDcd (const Dcd &dcd)
 
void ProcessDlMap (const DlMap &dlmap)
 
void ProcessUcd (const Ucd &ucd)
 
void ProcessUlMap (const UlMap &ulmap)
 

Static Private Member Functions

static Time GetDefaultLostDlMapInterval ()
 

Private Attributes

double m_allocationStartTime
 
bool m_areManagementConnectionsAllocated
 
bool m_areServiceFlowsAllocated
 
Mac48Address m_baseStationId
 
Ptr< WimaxConnectionm_basicConnection
 
Ptr< IpcsClassifierm_classifier
 
uint8_t m_dcdCount
 
EventId m_dcdWaitTimeoutEvent
 
OfdmDlBurstProfilem_dlBurstProfile
 
Time m_intervalT1
 
Time m_intervalT12
 
Time m_intervalT2
 
Time m_intervalT20
 
Time m_intervalT21
 
Time m_intervalT3
 
Time m_intervalT7
 
EventId m_lostDlMapEvent
 
Time m_lostDlMapInterval
 
EventId m_lostUlMapEvent
 
Time m_lostUlMapInterval
 
uint8_t m_maxContentionRangingRetries
 
Time m_maxDcdInterval
 
Time m_maxUcdInterval
 
WimaxPhy::ModulationType m_modulationType
 
uint32_t m_nrDcdRecvd
 
uint16_t m_nrDlMapElements
 
uint32_t m_nrDlMapRecvd
 
uint32_t m_nrUcdRecvd
 
uint16_t m_nrUlMapElements
 
uint32_t m_nrUlMapRecvd
 
Ptr< WimaxConnectionm_primaryConnection
 
EventId m_rangOppWaitTimeoutEvent
 
Ptr< SSSchedulerm_scheduler
 
Ptr< SsServiceFlowManagerm_serviceFlowManager
 
TracedCallback< Ptr< const
Packet > > 
m_ssPromiscRxTrace
 
TracedCallback< Ptr< const
Packet > > 
m_ssRxDropTrace
 
TracedCallback< Ptr< const
Packet > > 
m_ssRxTrace
 
TracedCallback< Ptr< const
Packet > > 
m_ssTxDropTrace
 
TracedCallback< Ptr< const
Packet > > 
m_ssTxTrace
 
TracedCallback< Ptr< const
Packet >, Mac48Address, Cid * > 
m_traceSSRx
 
TracedCallback< Ptr< const
PacketBurst >, Mac48Address,
Cid
*, WimaxPhy::ModulationType > 
m_traceSSTx
 
uint8_t m_ucdCount
 
EventId m_ucdWaitTimeoutEvent
 
OfdmUlBurstProfilem_ulBurstProfile
 

Additional Inherited Members

- Static Public Attributes inherited from ns3::WimaxNetDevice
static uint8_t m_direction = ~0
 
static Time m_frameStartTime = Seconds (0)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Config Paths

ns3::SubscriberStationNetDevice is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice

Attributes

  • BasicConnection: Basic connection
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxConnection >
    • Initial value: 0
    • Flags: construct write read
  • PrimaryConnection: Primary connection
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxConnection >
    • Initial value: 0
    • Flags: construct write read
  • LostDlMapInterval: Time since last received DL-MAP message before downlink synchronization is considered lost. Maximum is 600ms
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +500000000.0ns
    • Flags: construct write read
  • LostUlMapInterval: Time since last received UL-MAP before uplink synchronization is considered lost, maximum is 600.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +500000000.0ns
    • Flags: construct write read
  • MaxDcdInterval: Maximum time between transmission of DCD messages. Maximum is 10s
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +10000000000.0ns
    • Flags: construct write read
  • MaxUcdInterval: Maximum time between transmission of UCD messages. Maximum is 10s
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +10000000000.0ns
    • Flags: construct write read
  • IntervalT1: Wait for DCD timeout. Maximum is 5*maxDcdInterval
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +50000000000.0ns
    • Flags: construct write read
  • IntervalT2: Wait for broadcast ranging timeout, i.e., wait for initial ranging opportunity. Maximum is 5*Ranging interval
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +10000000000.0ns
    • Flags: construct write read
  • IntervalT3: ranging Response reception timeout following the transmission of a ranging request. Maximum is 200ms
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +200000000.0ns
    • Flags: construct write read
  • IntervalT7: wait for DSA/DSC/DSD Response timeout. Maximum is 1s
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +100000000.0ns
    • Flags: construct write read
  • IntervalT12: Wait for UCD descriptor.Maximum is 5*MaxUcdInterval
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +10000000000.0ns
    • Flags: construct write read
  • IntervalT20: Time the SS searches for preambles on a given channel. Minimum is 2 MAC frames
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +500000000.0ns
    • Flags: construct write read
  • IntervalT21: time the SS searches for (decodable) DL-MAP on a given channel
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +10000000000.0ns
    • Flags: construct write read
  • MaxContentionRangingRetries: Number of retries on contention Ranging Requests
  • SSScheduler: The ss scheduler attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::SSScheduler >
    • Initial value: 0
    • Flags: construct write read
  • LinkManager: The ss link manager attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::SSLinkManager >
    • Initial value: 0
    • Flags: construct write read
  • Classifier: The ss classifier attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::IpcsClassifier >
    • Initial value: 0
    • Flags: construct write read

Attributes defined in parent class ns3::WimaxNetDevice

  • Mtu: The MAC-level Maximum Transmission Unit
  • Phy: The PHY layer attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxPhy >
    • Initial value: 0
    • Flags: construct write read
  • Channel: The channel attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxChannel >
    • Initial value: 0
    • Flags: construct write read
  • RTG: receive/transmit transition gap.
  • TTG: transmit/receive transition gap.
  • ConnectionManager: The connection manager attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::ConnectionManager >
    • Initial value: 0
    • Flags: construct write read
  • BurstProfileManager: The burst profile manager attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::BurstProfileManager >
    • Initial value: 0
    • Flags: construct write read
  • BandwidthManager: The bandwidth manager attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::BandwidthManager >
    • Initial value: 0
    • Flags: construct write read
  • InitialRangingConnection: Initial ranging connection
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxConnection >
    • Initial value: 0
    • Flags: construct write read
  • BroadcastConnection: Broadcast connection
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxConnection >
    • Initial value: 0
    • Flags: construct write read

TraceSources

  • SSTxDrop: A packet has been dropped in the MAC layer before being queued for transmission.
  • SSPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • SSRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • SSRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.

TraceSources defined in parent class ns3::WimaxNetDevice

  • Rx: Receive trace
  • Tx: Transmit trace

Definition at line 47 of file ss-net-device.h.

Member Function Documentation

void ns3::SubscriberStationNetDevice::DoDispose ( void  )
privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::WimaxNetDevice.

Definition at line 263 of file ss-net-device.cc.

References ns3::WimaxNetDevice::DoDispose().

bool ns3::SubscriberStationNetDevice::Enqueue ( Ptr< Packet packet,
const MacHeaderType hdrType,
Ptr< WimaxConnection connection 
)
virtual

Enqueue a packet into a connection queue.

Parameters
packetthe packet to be enqueued
hdrTypethe mac header type to be appended to the packet
connectionthe connection to be used

Implements ns3::WimaxNetDevice.

Definition at line 652 of file ss-net-device.cc.

References ns3::Packet::AddHeader(), ns3::GenericMacHeader::GetSerializedSize(), ns3::Packet::GetSize(), NS_ASSERT_MSG, and NS_LOG_INFO.

bool ns3::SubscriberStationNetDevice::GetAreManagementConnectionsAllocated ( void  ) const
Returns
true if the management connections are allocated, false otherwise

Definition at line 479 of file ss-net-device.cc.

bool ns3::SubscriberStationNetDevice::GetAreServiceFlowsAllocated ( void  ) const
Returns
true if the service flows are allocated, false otherwise

Definition at line 491 of file ss-net-device.cc.

Cid ns3::SubscriberStationNetDevice::GetBasicCid ( void  ) const
Returns
the basic CID

Definition at line 449 of file ss-net-device.cc.

Ptr< WimaxConnection > ns3::SubscriberStationNetDevice::GetBasicConnection ( void  ) const
Returns
the basic connection currently in use

Definition at line 431 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT1 ( void  ) const

returns the wait for DCD timeout

Definition at line 335 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT12 ( void  ) const

returns the wait for UCD descriptor timeout

Definition at line 383 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT2 ( void  ) const

returns the wait for broadcast ranging timeout, i.e., wait for initial ranging opportunity

Definition at line 347 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT20 ( void  ) const

returns the Time the SS searches for preambles on a given channel

Definition at line 395 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT21 ( void  ) const

returns the time the SS searches for (decodable) DL-MAP on a given channel

Definition at line 407 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT3 ( void  ) const

returns the ranging Response reception timeout following the transmission of a ranging request

Definition at line 359 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetIntervalT7 ( void  ) const

returns the wait for DSA/DSC/DSD Response timeout

Definition at line 371 of file ss-net-device.cc.

Ptr< IpcsClassifier > ns3::SubscriberStationNetDevice::GetIpcsClassifier ( ) const
Returns
a pointer to the CS packet classifier

Definition at line 515 of file ss-net-device.cc.

Ptr< SSLinkManager > ns3::SubscriberStationNetDevice::GetLinkManager ( void  ) const
Returns
a pointer to the link manger currently used

Definition at line 528 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetLostUlMapInterval ( void  ) const

returns the time since last received UL-MAP before uplink synchronization is considered lost

Definition at line 299 of file ss-net-device.cc.

uint8_t ns3::SubscriberStationNetDevice::GetMaxContentionRangingRetries ( void  ) const
Returns
the Number of retries on contention Ranging Requests

Definition at line 419 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetMaxDcdInterval ( void  ) const

returns the maximum time between transmission of DCD messages

Definition at line 311 of file ss-net-device.cc.

Time ns3::SubscriberStationNetDevice::GetMaxUcdInterval ( void  ) const

returns the maximum time between transmission of UCD messages

Definition at line 323 of file ss-net-device.cc.

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

returns the most efficient modulation and coding scheme (MCS) supported by the device

Definition at line 467 of file ss-net-device.cc.

Cid ns3::SubscriberStationNetDevice::GetPrimaryCid ( void  ) const
Returns
the primary CID

Definition at line 455 of file ss-net-device.cc.

Ptr< WimaxConnection > ns3::SubscriberStationNetDevice::GetPrimaryConnection ( void  ) const

returns the primary connection currently usde

Definition at line 443 of file ss-net-device.cc.

Ptr< SSScheduler > ns3::SubscriberStationNetDevice::GetScheduler ( void  ) const
Returns
the scheduler installed on the device

Definition at line 497 of file ss-net-device.cc.

Ptr< SsServiceFlowManager > ns3::SubscriberStationNetDevice::GetServiceFlowManager ( void  ) const
Returns
a pointer to the service flow manager installed on the device

Definition at line 540 of file ss-net-device.cc.

Referenced by AddServiceFlow(), and HasServiceFlows().

bool ns3::SubscriberStationNetDevice::HasServiceFlows ( void  ) const
Returns
true if the device has at least one active service flow, false otherwise

Definition at line 509 of file ss-net-device.cc.

References GetServiceFlowManager().

bool ns3::SubscriberStationNetDevice::IsRegistered ( void  ) const
Returns
true if the SS is registered to a BS, false otherwise

Definition at line 1255 of file ss-net-device.cc.

Referenced by SendBurst().

void ns3::SubscriberStationNetDevice::SetAreManagementConnectionsAllocated ( bool  areManagementConnectionsAllocated)
Parameters
areManagementConnectionsAllocatedtrue if the management connections are allocated, false otherwise

Definition at line 473 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetAreServiceFlowsAllocated ( bool  areServiceFlowsAllocated)
Parameters
areServiceFlowsAllocatedtrue if the service flows are allocated, false otherwise

Definition at line 485 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetBasicConnection ( Ptr< WimaxConnection basicConnection)
Parameters
basicConnectionthe basic connection to be used

Definition at line 425 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT1 ( Time  interval1)
Parameters
interval1Wait for DCD timeout

Definition at line 329 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT12 ( Time  interval12)
Parameters
interval12the Wait for UCD descriptor timeout

Definition at line 377 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT2 ( Time  interval2)
Parameters
interval2the wait for broadcast ranging timeout, i.e., wait for initial ranging opportunity

Definition at line 341 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT20 ( Time  interval20)
Parameters
interval20the Time the SS searches for preambles on a given channel

Definition at line 389 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT21 ( Time  interval21)
Parameters
interval21the time the SS searches for (decodable) DL-MAP on a given channel

Definition at line 401 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT3 ( Time  interval3)
Parameters
interval3the ranging Response reception timeout following the transmission of a ranging request

Definition at line 353 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetIntervalT7 ( Time  interval7)
Parameters
interval7the wait for DSA/DSC/DSD Response timeout

Definition at line 365 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetLostDlMapInterval ( Time  lostDlMapInterval)
Parameters
lostDlMapIntervaltime since last received DL-MAP message before downlink synchronization is considered lost

Definition at line 281 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetLostUlMapInterval ( Time  lostUlMapInterval)
Parameters
lostUlMapIntervalTime since last received UL-MAP before uplink synchronization is considered lost

Definition at line 293 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetMaxContentionRangingRetries ( uint8_t  maxContentionRangingRetries)
Parameters
maxContentionRangingRetriesthe Number of retries on contention Ranging Requests

Definition at line 413 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetMaxDcdInterval ( Time  maxDcdInterval)
Parameters
maxDcdIntervalMaximum time between transmission of DCD messages

Definition at line 305 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetMaxUcdInterval ( Time  maxUcdInterval)
Parameters
maxUcdIntervalMaximum time between transmission of UCD messages

Definition at line 317 of file ss-net-device.cc.

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

Set the most efficient modulation and coding scheme (MCS) supported by the device.

Parameters
modulationTypethe most robust MCS supported

Definition at line 461 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetPrimaryConnection ( Ptr< WimaxConnection primaryConnection)
Parameters
primaryConnectionthe primary connection to be used

Definition at line 437 of file ss-net-device.cc.

void ns3::SubscriberStationNetDevice::SetScheduler ( Ptr< SSScheduler ssScheduler)
Parameters
ssSchedulerthe scheduler to be installed on the device

Definition at line 503 of file ss-net-device.cc.

Member Data Documentation

TracedCallback<Ptr<const Packet> > ns3::SubscriberStationNetDevice::m_ssPromiscRxTrace
private

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). This is a promiscuous trace.

See Also
class CallBackTraceSource

Definition at line 379 of file ss-net-device.h.

TracedCallback<Ptr<const Packet> > ns3::SubscriberStationNetDevice::m_ssRxDropTrace
private

The trace source fired when packets coming into the "top" of the device are dropped at the MAC layer during reception.

See Also
class CallBackTraceSource

Definition at line 396 of file ss-net-device.h.

TracedCallback<Ptr<const Packet> > ns3::SubscriberStationNetDevice::m_ssRxTrace
private

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). This is a non- promiscuous trace.

See Also
class CallBackTraceSource

Definition at line 388 of file ss-net-device.h.

TracedCallback<Ptr<const Packet> > ns3::SubscriberStationNetDevice::m_ssTxDropTrace
private

The trace source fired when packets coming into the "top" of the device are dropped at the MAC layer during transmission.

See Also
class CallBackTraceSource

Definition at line 370 of file ss-net-device.h.

TracedCallback<Ptr<const Packet> > ns3::SubscriberStationNetDevice::m_ssTxTrace
private

The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission.

See Also
class CallBackTraceSource

Definition at line 362 of file ss-net-device.h.


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