ns-3
ns3::LteUeNetDevice Class Reference

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

Inheritance diagram for ns3::LteUeNetDevice:
Collaboration diagram for ns3::LteUeNetDevice:

List of all members.

Public Member Functions

 LteUeNetDevice (Ptr< Node > node, Ptr< LteUePhy > phy, Ptr< LteUeMac > mac, Ptr< LteUeRrc > rrc)
 Create an UE net device.
virtual void DoDispose ()
virtual bool Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
Ptr< LteUeMacGetMac (void)
Ptr< LteUeRrcGetRrc ()
Ptr< LteUePhyGetPhy (void) const
void SetTargetEnb (Ptr< LteEnbNetDevice > enb)
 Set the targer eNB where the UE is registered.
Ptr< LteEnbNetDeviceGetTargetEnb (void)
 Get the targer eNB where the UE is registered.
uint64_t GetImsi ()
- Public Member Functions inherited from ns3::LteNetDevice
virtual void SetIfIndex (const uint32_t index)
virtual uint32_t GetIfIndex (void) const
virtual Ptr< ChannelGetChannel (void) const
virtual bool SetMtu (const uint16_t mtu)
virtual uint16_t GetMtu (void) const
virtual void SetAddress (Address address)
virtual Address GetAddress (void) const
virtual bool IsLinkUp (void) const
virtual void AddLinkChangeCallback (Callback< void > callback)
virtual bool IsBroadcast (void) const
virtual Address GetBroadcast (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 IsBridge (void) const
 Return true if the net device is acting as a bridge.
virtual Ptr< NodeGetNode (void) const
virtual void SetNode (Ptr< Node > node)
virtual bool NeedsArp (void) const
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
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 void SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual bool SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
virtual bool SupportsSendFrom (void) const
void Receive (Ptr< Packet > p)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::LteUeNetDevice.

Protected Member Functions

virtual void DoStart (void)

Additional Inherited Members

- Protected Attributes inherited from ns3::LteNetDevice
NetDevice::ReceiveCallback m_rxCallback

Detailed Description

The LteUeNetDevice class implements the UE net device


Constructor & Destructor Documentation

ns3::LteUeNetDevice::LteUeNetDevice ( Ptr< Node node,
Ptr< LteUePhy phy,
Ptr< LteUeMac mac,
Ptr< LteUeRrc rrc 
)

Create an UE net device.

Parameters:
node
phy

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.

References ns3::Object::Dispose(), and NS_LOG_FUNCTION.

void ns3::LteUeNetDevice::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.

References NS_LOG_FUNCTION, and ns3::Object::Start().

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

Get the targer eNB where the UE is registered.

Returns:
the pointer to the enb

References NS_LOG_FUNCTION.

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

This method returns the TypeId associated to ns3::LteUeNetDevice.

This object 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 defined for this type:

Attributes defined in parent class ns3::LteNetDevice:

  • Mtu: The MAC-level Maximum Transmission Unit

No TraceSources defined for this type.

Reimplemented from ns3::LteNetDevice.

References ns3::TypeId::SetParent().

bool ns3::LteUeNetDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
)
virtual
Parameters:
packetpacket sent from above down to Network Device
destmac address of the destination (already resolved)
protocolNumberidentifies 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.

References NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::LteUeRrc::Send().

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

Set the targer eNB where the UE is registered.

Parameters:
enb

References ns3::LtePhy::DoSetCellId(), ns3::LteEnbNetDevice::GetCellId(), and NS_LOG_FUNCTION.


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