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

Inheritance diagram for ns3::LteUeNetDevice:

Public Member Functions
	LteUeNetDevice (Ptr< Node > node, Ptr< LteUePhy > phy, Ptr< LteUeMac > mac, Ptr< LteUeRrc > rrc, Ptr< EpcUeNas > nas, uint64_t imsi)
	Create an UE net device. More...

virtual void	DoDispose ()

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	SetTargetEnb (Ptr< LteEnbNetDevice > enb)
	Set the targer eNB where the UE is registered. More...

Public Member Functions inherited from ns3::LteNetDevice
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)

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::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	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	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
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)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Protected Member Functions
virtual void	DoInitialize (void)

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

virtual void	NotifyNewAggregate (void)

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

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
void	UpdateConfig (void)

Private Attributes
uint64_t	m_imsi

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 }

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

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
- Flags: 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	(	Ptr< Node >	node,
		Ptr< LteUePhy >	phy,
		Ptr< LteUeMac >	mac,
		Ptr< LteUeRrc >	rrc,
		Ptr< EpcUeNas >	nas,
		uint64_t	imsi
	)

Create an UE net device.

Parameters

node	the node to which the device belongs
phy	the PHY entity
mac	the MAC entity
rrc	the RRC entity
nas	the NAS entity
imsi	the unique UE identifier

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

References NS_LOG_FUNCTION, and ns3::LteNetDevice::SetNode().

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 111 of file lte-ue-net-device.cc.

References ns3::LteNetDevice::DoDispose(), and NS_LOG_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 190 of file lte-ue-net-device.cc.

References NS_LOG_FUNCTION, and UpdateConfig().

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

Get the targer eNB where the UE is registered.

Returns: the pointer to the enb

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

References NS_LOG_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 200 of file lte-ue-net-device.cc.

References NS_ASSERT_MSG, and NS_LOG_FUNCTION.

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

Set the targer eNB where the UE is registered.

Parameters

enb

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

References NS_LOG_FUNCTION.

void ns3::LteUeNetDevice::UpdateConfig ( void )

private

Some attributes are exported as attributes of the LteUeNetDevice from a user perspective, but are actually used also in other modules as well (the RRC, the PHY...). 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 LteUeNetDevice.

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

References NS_LOG_FUNCTION.

Referenced by DoInitialize().

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

src/lte/model/lte-ue-net-device.h
src/lte/model/lte-ue-net-device.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::LteNetDevice

Constructor & Destructor Documentation

Member Function Documentation