The LteUeNetDevice class implements the UE net device. More...

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

Inheritance diagram for ns3::LteUeNetDevice:

Collaboration diagram for ns3::LteUeNetDevice:

Public Member Functions
	LteUeNetDevice (void)

virtual	~LteUeNetDevice (void)

virtual void	DoDispose ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

uint32_t	GetCsgId () const
	Returns the CSG ID the UE is currently a member of. More...

uint16_t	GetDlEarfcn () const

uint64_t	GetImsi () const

Ptr< LteUeMac >	GetMac (void) const

Ptr< EpcUeNas >	GetNas (void) const

Ptr< LteUePhy >	GetPhy (void) const

Ptr< LteUeRrc >	GetRrc () const

Ptr< LteEnbNetDevice >	GetTargetEnb (void)
	Get the targer eNB where the UE is registered. More...

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

void	SetCsgId (uint32_t csgId)
	Enlist the UE device as a member of a particular CSG. More...

void	SetDlEarfcn (uint16_t earfcn)

void	SetTargetEnb (Ptr< LteEnbNetDevice > enb)
	Set the targer eNB where the UE is registered. More...

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. More...

virtual Address	GetMulticast (Ipv6Address addr) const
	Get the MAC multicast address corresponding to the IPv6 address provided. More...

virtual Ptr< Node >	GetNode (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...

virtual bool	NeedsArp (void) const

void	Receive (Ptr< Packet > p)
	receive a packet from the lower layers in order to forward it to the upper layers More...

virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)

virtual void	SetAddress (Address address)
	Set the address of this interface. More...

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)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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::LteNetDevice
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::NetDevice
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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Protected Member Functions
virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Private Member Functions
void	UpdateConfig ()
	Propagate attributes and configuration to sub-modules. More...

Private Attributes
uint32_t	m_csgId

uint16_t	m_dlEarfcn
	downlink carrier frequency More...

uint64_t	m_imsi

bool	m_isConstructed

Ptr< LteUeMac >	m_mac

Ptr< EpcUeNas >	m_nas

Ptr< LteUePhy >	m_phy

Ptr< LteUeRrc >	m_rrc

Ptr< LteEnbNetDevice >	m_targetEnb

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 }
	Packet types are used as they are in Linux. More...

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 LteUeNetDevice class implements the UE net device.

Config Paths

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

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

Attributes

EpcUeNas: The NAS associated to this UeNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::EpcUeNas>
- Initial value: 0
- Flags: construct write read
LteUeRrc: The RRC associated to this UeNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteUeRrc>
- Initial value: 0
- Flags: construct write read
LteUeMac: The MAC associated to this UeNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteUeMac>
- Initial value: 0
- Flags: construct write read
LteUePhy: The PHY associated to this UeNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteUePhy>
- Initial value: 0
- Flags: construct write read
Imsi: International Mobile Subscriber Identity assigned to this UE
- Set with class: ns3::UintegerValue
- Underlying type: uint64_t 0:18446744073709551615
- 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
CsgId: The Closed Subscriber Group (CSG) identity that this UE is associated with, i.e., giving the UE access to cells which belong to this particular CSG. This restriction only applies to initial cell selection and EPC-enabled simulation. This does not revoke the UE's access to non-CSG cells.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- 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 51 of file lte-ue-net-device.h.

Constructor & Destructor Documentation

ns3::LteUeNetDevice::LteUeNetDevice ( void )

Definition at line 108 of file lte-ue-net-device.cc.

References NS_LOG_FUNCTION.

ns3::LteUeNetDevice::~LteUeNetDevice ( void )

virtual

Definition at line 114 of file lte-ue-net-device.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteUeNetDevice::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 120 of file lte-ue-net-device.cc.

References ns3::LteNetDevice::DoDispose(), m_mac, m_nas, m_phy, m_rrc, m_targetEnb, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::LteUeNetDevice::DoInitialize ( void )

protectedvirtual

This method is called only once by Object::Initialize.

If the user calls Object::Initialize multiple times, DoInitialize 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 241 of file lte-ue-net-device.cc.

References m_isConstructed, m_mac, m_phy, m_rrc, NS_LOG_FUNCTION, and UpdateConfig().

Here is the call graph for this function:

uint32_t ns3::LteUeNetDevice::GetCsgId ( ) const

Returns the CSG ID the UE is currently a member of.

Returns: the Closed Subscriber Group identity

Definition at line 211 of file lte-ue-net-device.cc.

References m_csgId, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint16_t ns3::LteUeNetDevice::GetDlEarfcn ( ) const

Returns: the downlink carrier frequency (EARFCN)

Note that real-life handset typically supports more than one EARFCN, but the sake of simplicity we assume only one EARFCN is supported.

Definition at line 197 of file lte-ue-net-device.cc.

References m_dlEarfcn, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint64_t ns3::LteUeNetDevice::GetImsi ( void ) const

Definition at line 190 of file lte-ue-net-device.cc.

References m_imsi, and NS_LOG_FUNCTION.

Referenced by LteX2HandoverTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckNotConnected(), LteCellSelectionTestCase::CheckPoint(), LteRrcConnectionEstablishmentTestCase::DoRun(), LteRrcConnectionEstablishmentErrorTestCase::DoRun(), ns3::LteStatsCalculator::FindImsiFromLteNetDevice(), and PrintGnuplottableUeListToFile().

Here is the caller graph for this function:

Ptr< LteUeMac > ns3::LteUeNetDevice::GetMac ( void ) const

Definition at line 160 of file lte-ue-net-device.cc.

References m_mac, and NS_LOG_FUNCTION.

Ptr< EpcUeNas > ns3::LteUeNetDevice::GetNas ( void ) const

Definition at line 183 of file lte-ue-net-device.cc.

References m_nas, and NS_LOG_FUNCTION.

Ptr< LteUePhy > ns3::LteUeNetDevice::GetPhy ( void ) const

Definition at line 176 of file lte-ue-net-device.cc.

References m_phy, and NS_LOG_FUNCTION.

Here is the caller graph for this function:

Ptr< LteUeRrc > ns3::LteUeNetDevice::GetRrc ( void ) const

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

References m_rrc, and NS_LOG_FUNCTION.

Referenced by LteX2HandoverTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckNotConnected(), and LteCellSelectionTestCase::CheckPoint().

Here is the caller graph for this function:

Ptr< LteEnbNetDevice > ns3::LteUeNetDevice::GetTargetEnb ( void )

Get the targer eNB where the UE is registered.

Returns: the pointer to the enb

Definition at line 234 of file lte-ue-net-device.cc.

References m_targetEnb, and NS_LOG_FUNCTION.

TypeId ns3::LteUeNetDevice::GetTypeId ( void )

static

Definition at line 54 of file lte-ue-net-device.cc.

References GetCsgId(), GetDlEarfcn(), m_imsi, m_mac, m_nas, m_phy, m_rrc, SetCsgId(), SetDlEarfcn(), and ns3::TypeId::SetParent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::LteUeNetDevice::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 252 of file lte-ue-net-device.cc.

References m_nas, NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Ipv4L3Protocol::PROT_NUMBER.

void ns3::LteUeNetDevice::SetCsgId ( uint32_t csgId )

Enlist the UE device as a member of a particular CSG.

Parameters

csgId the intended Closed Subscriber Group identity

UE is associated with a single CSG identity, and thus becoming a member of this particular CSG. As a result, the UE may gain access to cells which belong to this CSG. This does not revoke the UE's access to non-CSG cells.

Note: This restriction only applies to initial cell selection and EPC-enabled simulation.

Definition at line 218 of file lte-ue-net-device.cc.

References m_csgId, NS_LOG_FUNCTION, and UpdateConfig().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters

earfcn the downlink carrier frequency (EARFCN)

Note that real-life handset typically supports more than one EARFCN, but the sake of simplicity we assume only one EARFCN is supported.

Definition at line 204 of file lte-ue-net-device.cc.

References m_dlEarfcn, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::LteUeNetDevice::SetTargetEnb ( Ptr< LteEnbNetDevice > enb )

Set the targer eNB where the UE is registered.

Parameters

enb

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

References m_targetEnb, and NS_LOG_FUNCTION.

void ns3::LteUeNetDevice::UpdateConfig ( void )

private

Propagate attributes and configuration to sub-modules.

Several attributes (e.g., the IMSI) are exported as the attributes of the LteUeNetDevice from a user perspective, but are actually used also in other sub-modules (the RRC, the PHY, etc.). This method takes care of updating the configuration of all these sub-modules so that their copy of attribute values are in sync with the one in the LteUeNetDevice.

Definition at line 136 of file lte-ue-net-device.cc.

References m_csgId, m_imsi, m_isConstructed, m_nas, m_rrc, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DoInitialize(), and SetCsgId().

Here is the caller graph for this function: