#include <lte-enb-net-device.h>

Inheritance diagram for ns3::LteEnbNetDevice:

Collaboration diagram for ns3::LteEnbNetDevice:

Public Member Functions
	LteEnbNetDevice ()
virtual	~LteEnbNetDevice (void)
virtual void	DoDispose (void)
uint16_t	GetCellId () const
uint8_t	GetDlBandwidth () const
uint16_t	GetDlEarfcn () const
Ptr< LteEnbMac >	GetMac (void) const
Ptr< LteEnbPhy >	GetPhy (void) const
Ptr< LteEnbRrc >	GetRrc () const
uint8_t	GetUlBandwidth () const
uint16_t	GetUlEarfcn () const
virtual bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
void	SetDlBandwidth (uint8_t bw)
void	SetDlEarfcn (uint16_t earfcn)
void	SetUlBandwidth (uint8_t bw)
void	SetUlEarfcn (uint16_t earfcn)
Public Member Functions inherited from ns3::LteNetDevice
	LteNetDevice (void)
virtual	~LteNetDevice (void)
virtual void	AddLinkChangeCallback (Callback< void > callback)
virtual Address	GetAddress (void) const
virtual Address	GetBroadcast (void) const
virtual Ptr< Channel >	GetChannel (void) const
virtual uint32_t	GetIfIndex (void) const
virtual uint16_t	GetMtu (void) const
virtual Address	GetMulticast (Ipv4Address addr) const
	Make and return a MAC multicast address using the provided multicast group.
virtual Address	GetMulticast (Ipv6Address addr) const
	Get the MAC multicast address corresponding to the IPv6 address provided.
virtual Ptr< Node >	GetNode (void) const
virtual bool	IsBridge (void) const
	Return true if the net device is acting as a bridge.
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.
virtual bool	NeedsArp (void) const
void	Receive (Ptr< Packet > p)
virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
virtual void	SetAddress (Address address)
virtual void	SetIfIndex (const uint32_t index)
virtual bool	SetMtu (const uint16_t mtu)
virtual void	SetNode (Ptr< Node > node)
virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual bool	SupportsSendFrom (void) const
Public Member Functions inherited from ns3::NetDevice
virtual	~NetDevice ()
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~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)

Protected Member Functions
virtual void	DoStart (void)

Private Member Functions
void	UpdateConfig (void)

Private Attributes
uint16_t	m_cellId
uint8_t	m_dlBandwidth
uint16_t	m_dlEarfcn
Ptr< LteEnbMac >	m_mac
Ptr< LteEnbPhy >	m_phy
Ptr< LteEnbRrc >	m_rrc
Ptr< FfMacScheduler >	m_scheduler
uint8_t	m_ulBandwidth
uint16_t	m_ulEarfcn

Static Private Attributes
static uint16_t	m_cellIdCounter = 0

Additional Inherited Members
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
Protected Attributes inherited from ns3::LteNetDevice
NetDevice::ReceiveCallback	m_rxCallback

Detailed Description

The eNodeB device implementation

Config Paths

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

/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice

Attributes

LteEnbRrc: The RRC associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteEnbRrc >
- Initial value: 0
- Flags: construct write read
LteEnbMac: The MAC associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteEnbMac >
- Initial value: 0
- Flags: construct write read
FfMacScheduler: The scheduler associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::FfMacScheduler >
- Initial value: 0
- Flags: construct write read
LteEnbPhy: The PHY associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteEnbPhy >
- Initial value: 0
- Flags: construct write read
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: construct write read
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: construct write read
CellId: Cell Identifier
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: construct write read
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: uint16_t 0:6149
- Initial value: 100
- Flags: construct write read
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: uint16_t 18000:24149
- Initial value: 18100
- Flags: construct write read

Attributes defined in parent class ns3::LteNetDevice

Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 30000
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 50 of file lte-enb-net-device.h.

Constructor & Destructor Documentation

ns3::LteEnbNetDevice::LteEnbNetDevice ( )

Definition at line 113 of file lte-enb-net-device.cc.

References NS_LOG_FUNCTION.

ns3::LteEnbNetDevice::~LteEnbNetDevice ( void )

virtual

Definition at line 118 of file lte-enb-net-device.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteEnbNetDevice::DoDispose ( void )

virtual

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::LteNetDevice.

Definition at line 124 of file lte-enb-net-device.cc.

References ns3::Object::Dispose(), m_mac, m_phy, m_rrc, m_scheduler, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::LteEnbNetDevice::DoStart ( void )

protectedvirtual

This method is called only once by Object::Start. If the user calls Object::Start multiple times, DoStart is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented from ns3::Object.

Definition at line 251 of file lte-enb-net-device.cc.

References m_cellId, m_cellIdCounter, m_mac, m_phy, m_rrc, NS_ABORT_MSG_IF, ns3::Object::Start(), and UpdateConfig().

Here is the call graph for this function:

uint16_t ns3::LteEnbNetDevice::GetCellId ( ) const

Returns: the Cell Identifier of this eNB

Definition at line 168 of file lte-enb-net-device.cc.

References m_cellId.

Referenced by ns3::LteHelper::Attach(), ns3::FindCellIdFromEnbRlcPath(), PrintGnuplottableEnbListToFile(), and ns3::LteUeNetDevice::SetTargetEnb().

Here is the caller graph for this function:

uint8_t ns3::LteEnbNetDevice::GetDlBandwidth ( ) const

Returns: the downlink bandwidth in RBs

Definition at line 200 of file lte-enb-net-device.cc.

References m_dlBandwidth.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint16_t ns3::LteEnbNetDevice::GetDlEarfcn ( ) const

Returns: the downlink carrier frequency (EARFCN)

Definition at line 226 of file lte-enb-net-device.cc.

References m_dlEarfcn.

Referenced by ns3::LteHelper::Attach(), and ns3::LteHelper::InstallSingleEnbDevice().

Here is the caller graph for this function:

Ptr< LteEnbMac > ns3::LteEnbNetDevice::GetMac ( void ) const

Returns: a pointer to the MAC

Definition at line 146 of file lte-enb-net-device.cc.

References m_mac, and NS_LOG_FUNCTION.

Ptr< LteEnbPhy > ns3::LteEnbNetDevice::GetPhy ( void ) const

Returns: a pointer to the physical layer.

Definition at line 154 of file lte-enb-net-device.cc.

References m_phy, and NS_LOG_FUNCTION.

Here is the caller graph for this function:

Ptr< LteEnbRrc > ns3::LteEnbNetDevice::GetRrc ( ) const

Returns: a pointer to the Radio Resource Control instance of the eNB

Definition at line 162 of file lte-enb-net-device.cc.

References m_rrc.

TypeId ns3::LteEnbNetDevice::GetTypeId ( void )

static

Reimplemented from ns3::LteNetDevice.

Definition at line 53 of file lte-enb-net-device.cc.

References GetDlBandwidth(), GetUlBandwidth(), m_cellId, m_dlEarfcn, m_mac, m_phy, m_rrc, m_scheduler, m_ulEarfcn, SetDlBandwidth(), ns3::TypeId::SetParent(), and SetUlBandwidth().

Referenced by ns3::LteHelper::LteHelper().

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t ns3::LteEnbNetDevice::GetUlBandwidth ( ) const

Returns: the uplink bandwidth in RBs

Definition at line 174 of file lte-enb-net-device.cc.

References m_ulBandwidth.

Referenced by ns3::LteHelper::Attach(), and GetTypeId().

Here is the caller graph for this function:

uint16_t ns3::LteEnbNetDevice::GetUlEarfcn ( ) const

Returns: the uplink carrier frequency (EARFCN)

Definition at line 238 of file lte-enb-net-device.cc.

References m_ulEarfcn.

Referenced by ns3::LteHelper::InstallSingleEnbDevice().

Here is the caller graph for this function:

bool ns3::LteEnbNetDevice::Send	(	Ptr< Packet >	packet,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Parameters

packet	packet sent from above down to Network Device
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device to the specified destination Address

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

Definition at line 264 of file lte-enb-net-device.cc.

References m_rrc, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::Ipv4L3Protocol::PROT_NUMBER, and ns3::LteEnbRrc::Send().

Here is the call graph for this function:

void ns3::LteEnbNetDevice::SetDlBandwidth ( uint8_t bw )

Parameters

bw	the downlink bandwidth in RBs

Definition at line 206 of file lte-enb-net-device.cc.

References m_dlBandwidth, and NS_FATAL_ERROR.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::LteEnbNetDevice::SetDlEarfcn ( uint16_t earfcn )

Parameters

bw	the downlink carrier frequency (EARFCN)

Definition at line 232 of file lte-enb-net-device.cc.

References m_dlEarfcn.

void ns3::LteEnbNetDevice::SetUlBandwidth ( uint8_t bw )

Parameters

bw	the uplink bandwidth in RBs

Definition at line 180 of file lte-enb-net-device.cc.

References m_ulBandwidth, and NS_FATAL_ERROR.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::LteEnbNetDevice::SetUlEarfcn ( uint16_t earfcn )

Parameters

bw	the uplink carrier frequency (EARFCN)

Definition at line 244 of file lte-enb-net-device.cc.

References m_ulEarfcn.

void ns3::LteEnbNetDevice::UpdateConfig ( void )

private

Several attributes (e.g., the bandwidth) are exported as attributes of the LteEnbNetDevice from a user perspective, but are actually used also in other modules as well (the RRC, the PHY, the scheduler...). This methods takes care of updating the configuration of all modules so that their copy of the attribute values is in sync with the one in the LteEnbNetDevice.

Definition at line 275 of file lte-enb-net-device.cc.

References ns3::LteEnbRrc::ConfigureCell(), ns3::LtePhy::DoSetBandwidth(), ns3::LtePhy::DoSetCellId(), ns3::LtePhy::DoSetEarfcn(), m_cellId, m_dlBandwidth, m_dlEarfcn, m_phy, m_rrc, m_ulBandwidth, m_ulEarfcn, NS_LOG_FUNCTION, and ns3::LteEnbRrc::SetCellId().