A Discrete-Event Network Simulator
API
ns3::ComponentCarrierBaseStation Class Reference

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

Static Public Member Functions

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

Protected Attributes

uint16_t m_cellId
 Cell identifier. More...
 
- Protected Attributes inherited from ns3::ComponentCarrier
uint16_t m_csgId
 CSG ID. More...
 
bool m_csgIndication
 CSG indication. More...
 
bool m_isConstructed
 whether the instance is constructed More...
 
bool m_primaryCarrier
 whether the carrier is primary More...
 

Additional Inherited Members

- Public Attributes inherited from ns3::ComponentCarrier
uint8_t m_dlBandwidth
 downlink bandwidth in RBs More...
 
uint32_t m_dlEarfcn
 downlink carrier frequency More...
 
uint8_t m_ulBandwidth
 uplink bandwidth in RBs More...
 
uint32_t m_ulEarfcn
 uplink carrier frequency More...
 
- Protected Member Functions inherited from ns3::ComponentCarrier
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

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

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

Constructor & Destructor Documentation

◆ ComponentCarrierBaseStation()

ns3::ComponentCarrierBaseStation::ComponentCarrierBaseStation ( )

Definition at line 186 of file component-carrier-enb.cc.

References NS_LOG_FUNCTION.

◆ ~ComponentCarrierBaseStation()

ns3::ComponentCarrierBaseStation::~ComponentCarrierBaseStation ( void  )
virtual

Definition at line 191 of file component-carrier-enb.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetCellId()

uint16_t ns3::ComponentCarrierBaseStation::GetCellId ( )

Get cell identifier.

Returns
cell identifier

Definition at line 197 of file component-carrier-enb.cc.

References m_cellId.

◆ GetTypeId()

TypeId ns3::ComponentCarrierBaseStation::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 175 of file component-carrier-enb.cc.

References 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 203 of file component-carrier-enb.cc.

References m_cellId, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_cellId

uint16_t ns3::ComponentCarrierBaseStation::m_cellId
protected

Cell identifier.

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

Referenced by GetCellId(), and SetCellId().


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