A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::Cid Class Reference

Cid class. More...

#include "cid.h"

+ Collaboration diagram for ns3::Cid:

Public Types

enum  Type {
  BROADCAST = 1 , INITIAL_RANGING , BASIC , PRIMARY ,
  TRANSPORT , MULTICAST , PADDING
}
 Type enumeration. More...
 

Public Member Functions

 Cid ()
 Create a cid of unknown type.
 
 Cid (uint16_t cid)
 Constructor.
 
 ~Cid ()
 
uint16_t GetIdentifier () const
 
bool IsBroadcast () const
 
bool IsInitialRanging () const
 
bool IsMulticast () const
 
bool IsPadding () const
 

Static Public Member Functions

static Cid Broadcast ()
 
static Cid InitialRanging ()
 
static Cid Padding ()
 

Private Attributes

uint16_t m_identifier
 identiifier
 

Friends

class CidFactory
 allow CidFactory class friend access
 
bool operator== (const Cid &lhs, const Cid &rhs)
 equality operator
 

Detailed Description

Cid class.

Definition at line 25 of file cid.h.

Member Enumeration Documentation

◆ Type

Type enumeration.

Enumerator
BROADCAST 
INITIAL_RANGING 
BASIC 
PRIMARY 
TRANSPORT 
MULTICAST 
PADDING 

Definition at line 29 of file cid.h.

Constructor & Destructor Documentation

◆ Cid() [1/2]

ns3::Cid::Cid ( )

Create a cid of unknown type.

Definition at line 19 of file cid.cc.

References CID_UNINITIALIZED, and m_identifier.

◆ Cid() [2/2]

ns3::Cid::Cid ( uint16_t cid)

Constructor.

Parameters
cid

Definition at line 24 of file cid.cc.

References m_identifier.

◆ ~Cid()

ns3::Cid::~Cid ( )

Definition at line 29 of file cid.cc.

Member Function Documentation

◆ Broadcast()

Cid ns3::Cid::Broadcast ( )
static
Returns
the broadcast cid

Definition at line 64 of file cid.cc.

Referenced by ns3::CidFactory::Allocate(), ns3::WimaxNetDevice::CreateDefaultConnections(), and IsBroadcast().

+ Here is the caller graph for this function:

◆ GetIdentifier()

uint16_t ns3::Cid::GetIdentifier ( ) const
Returns
the identifier of the cid

Definition at line 34 of file cid.cc.

References m_identifier.

Referenced by ns3::BSSchedulerRtps::BSSchedulerBroadcastConnection(), ns3::ServiceFlowManager::GetServiceFlow(), ns3::operator<<(), ns3::BandwidthRequestHeader::Print(), ns3::BandwidthRequestHeader::Serialize(), ns3::GenericMacHeader::Serialize(), ns3::RngRsp::Serialize(), ns3::OfdmDlMapIe::Write(), and ns3::OfdmUlMapIe::Write().

+ Here is the caller graph for this function:

◆ InitialRanging()

Cid ns3::Cid::InitialRanging ( )
static
Returns
the initial ranging cid

Definition at line 76 of file cid.cc.

Referenced by ns3::BsServiceFlowManager::BsServiceFlowManager(), ns3::CidFactory::Allocate(), ns3::WimaxNetDevice::CreateDefaultConnections(), ns3::BaseStationNetDevice::CreateDlMap(), IsInitialRanging(), ns3::UplinkSchedulerRtps::Schedule(), and ns3::UplinkSchedulerSimple::Schedule().

+ Here is the caller graph for this function:

◆ IsBroadcast()

bool ns3::Cid::IsBroadcast ( ) const
Returns
true if the cid is a broadcast cid, false otherwise

Definition at line 46 of file cid.cc.

References Broadcast().

Referenced by ns3::BaseStationNetDevice::DoReceive(), and ns3::BaseStationNetDevice::GetConnection().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsInitialRanging()

bool ns3::Cid::IsInitialRanging ( ) const
Returns
true if the cid is an initial ranging cid, false otherwise

Definition at line 58 of file cid.cc.

References InitialRanging().

Referenced by ns3::BaseStationNetDevice::DoReceive(), ns3::BaseStationNetDevice::GetConnection(), and ns3::BSLinkManager::PerformRanging().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsMulticast()

bool ns3::Cid::IsMulticast ( ) const
Returns
true if the cid is a multicast cid, false otherwise

Definition at line 40 of file cid.cc.

References m_identifier.

Referenced by ns3::SubscriberStationNetDevice::DoReceive().

+ Here is the caller graph for this function:

◆ IsPadding()

bool ns3::Cid::IsPadding ( ) const
Returns
true if the cid is a padding cid, false otherwise

Definition at line 52 of file cid.cc.

References Padding().

+ Here is the call graph for this function:

◆ Padding()

Cid ns3::Cid::Padding ( )
static
Returns
the padding cid

Definition at line 70 of file cid.cc.

Referenced by ns3::CidFactory::Allocate(), and IsPadding().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ CidFactory

friend class CidFactory
friend

allow CidFactory class friend access

Definition at line 84 of file cid.h.

◆ operator==

bool operator== ( const Cid & lhs,
const Cid & rhs )
friend

equality operator

Parameters
lhsleft hand side
rhsright hand side
Returns
true if equal

Definition at line 88 of file cid.cc.

Member Data Documentation

◆ m_identifier

uint16_t ns3::Cid::m_identifier
private

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