A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ns3::ComponentCarrierBaseStation Class Reference
LTE Models

Defines a Base station, that is a ComponentCarrier but with a cell Id. More...

#include "component-carrier.h"

+ Inheritance diagram for ns3::ComponentCarrierBaseStation:
+ Collaboration diagram for ns3::ComponentCarrierBaseStation:

Public Member Functions

 ComponentCarrierBaseStation ()
 Constructor.
 
 ~ComponentCarrierBaseStation () override
 ~ComponentCarrierBaseStation
 
uint16_t GetCellId () const
 Get cell identifier.
 
void SetCellId (uint16_t cellId)
 Set physical cell identifier.
 
- Public Member Functions inherited from ns3::ComponentCarrier
 ComponentCarrier ()
 
 ~ComponentCarrier () override
 
void DoDispose () override
 Destructor implementation.
 
uint32_t GetCsgId () const
 Returns the CSG ID of the eNodeB.
 
bool GetCsgIndication () const
 Returns the CSG indication flag of the eNodeB.
 
uint16_t GetDlBandwidth () const
 
uint32_t GetDlEarfcn () const
 
uint16_t GetUlBandwidth () const
 
uint32_t GetUlEarfcn () const
 
bool IsPrimary () const
 Checks if the carrier is the primary carrier.
 
void SetAsPrimary (bool primaryCarrier)
 Set as primary carrier.
 
void SetCsgId (uint32_t csgId)
 Associate the eNodeB device with a particular CSG.
 
void SetCsgIndication (bool csgIndication)
 Enable or disable the CSG indication flag.
 
virtual void SetDlBandwidth (uint16_t bw)
 
void SetDlEarfcn (uint32_t earfcn)
 
virtual void SetUlBandwidth (uint16_t bw)
 
void SetUlEarfcn (uint32_t earfcn)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const final
 Get the most derived TypeId for this Object.
 
template<typename T>
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T>
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::ComponentCarrier
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Protected Attributes

uint16_t m_cellId {0}
 Cell identifier.
 
- Protected Attributes inherited from ns3::ComponentCarrier
uint32_t m_csgId {0}
 CSG ID.
 
bool m_csgIndication {false}
 CSG indication.
 
uint16_t m_dlBandwidth {0}
 downlink bandwidth in RBs *‍/
 
uint32_t m_dlEarfcn {0}
 downlink carrier frequency *‍/
 
bool m_primaryCarrier {false}
 whether the carrier is primary
 
uint16_t m_ulBandwidth {0}
 uplink bandwidth in RBs *‍/
 
uint32_t m_ulEarfcn {0}
 uplink carrier frequency *‍/
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

Defines a Base station, that is a ComponentCarrier but with a cell Id.

Introspection did not find any typical Config paths
No Attributes are defined for this type

Attributes defined in parent class ns3::ComponentCarrier

  • CsgId: The Closed Subscriber Group (CSG) identity that this eNodeB belongs to
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • CsgIndication: If true, only UEs which are members of the CSG (i.e. same CSG ID) can gain access to the eNodeB, therefore enforcing closed access mode. Otherwise, the eNodeB operates as a non-CSG cell and implements open access mode.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • DlBandwidth: Downlink Transmission Bandwidth Configuration in number of Resource Blocks
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 25
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • DlEarfcn: Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:262143
    • Initial value: 100
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • PrimaryCarrier: If true, this Carrier Component will be the Primary Carrier Component (PCC) Only one PCC per eNodeB is (currently) allowed
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UlBandwidth: Uplink Transmission Bandwidth Configuration in number of Resource Blocks
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 25
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UlEarfcn: Uplink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 18000:262143
    • Initial value: 18100
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type
ns3::ComponentCarrierBaseStation does not belong to a group
Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 157 of file component-carrier.h.

Constructor & Destructor Documentation

◆ ComponentCarrierBaseStation()

ns3::ComponentCarrierBaseStation::ComponentCarrierBaseStation ( )

Constructor.

Definition at line 233 of file component-carrier.cc.

References ns3::ComponentCarrier::ComponentCarrier(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ ~ComponentCarrierBaseStation()

ns3::ComponentCarrierBaseStation::~ComponentCarrierBaseStation ( )
override

~ComponentCarrierBaseStation

Definition at line 239 of file component-carrier.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetCellId()

uint16_t ns3::ComponentCarrierBaseStation::GetCellId ( ) const

Get cell identifier.

Returns
cell identifier

Definition at line 245 of file component-carrier.cc.

References m_cellId.

◆ GetTypeId()

TypeId ns3::ComponentCarrierBaseStation::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 225 of file component-carrier.cc.

References ns3::ComponentCarrier::ComponentCarrier(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetCellId()

void ns3::ComponentCarrierBaseStation::SetCellId ( uint16_t cellId)

Set physical cell identifier.

Parameters
cellIdcell identifier

Definition at line 251 of file component-carrier.cc.

References m_cellId, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_cellId

uint16_t ns3::ComponentCarrierBaseStation::m_cellId {0}
protected

Cell identifier.

Definition at line 189 of file component-carrier.h.

Referenced by GetCellId(), and SetCellId().

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