A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::LteUeNetDevice Class Reference

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

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

Public Member Functions

 LteUeNetDevice (void)
 LteUeNetDevice (Ptr< Node > node, Ptr< LteUePhy > phy, Ptr< LteUeMac > mac, Ptr< LteUeRrc > rrc)
 Create an UE net device.
virtual ~LteUeNetDevice (void)
virtual void DoDispose ()
uint64_t GetImsi ()
Ptr< LteUeMacGetMac (void)
Ptr< LteUePhyGetPhy (void) const
Ptr< LteUeRrcGetRrc ()
Ptr< LteEnbNetDeviceGetTargetEnb (void)
 Get the targer eNB where the UE is registered.
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.
- 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< ChannelGetChannel (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< NodeGetNode (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
SimpleRefCountoperator= (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)
 This method returns the TypeId associated to ns3::LteUeNetDevice.

Protected Member Functions

virtual void DoStart (void)

Private Member Functions

void UpdateConfig (void)

Private Attributes

uint64_t m_imsi
Ptr< LteUeMacm_mac
Ptr< LteUePhym_phy
Ptr< LteUeRrcm_rrc
Ptr< LteEnbNetDevicem_targetEnb

Static Private Attributes

static uint64_t m_imsiCounter = 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 LteUeNetDevice class implements the UE net device

Definition at line 49 of file lte-ue-net-device.h.

Constructor & Destructor Documentation

ns3::LteUeNetDevice::LteUeNetDevice ( void  )

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

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

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

Create an UE net device.

Parameters
node
phy

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

References m_imsi, m_imsiCounter, m_mac, m_phy, m_rrc, NS_LOG_FUNCTION, and ns3::LteNetDevice::SetNode().

+ Here is the call graph for this function:

ns3::LteUeNetDevice::~LteUeNetDevice ( void  )
virtual

Definition at line 104 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 110 of file lte-ue-net-device.cc.

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

+ Here is the call graph for this 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.

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

References m_mac, m_phy, m_rrc, NS_LOG_FUNCTION, ns3::Object::Start(), and UpdateConfig().

+ Here is the call graph for this function:

uint64_t ns3::LteUeNetDevice::GetImsi ( void  )

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

References m_imsi, and NS_LOG_FUNCTION.

Referenced by ns3::LteHelper::Attach(), ns3::FindImsiFromUeRlcPath(), and PrintGnuplottableUeListToFile().

+ Here is the caller graph for this function:

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

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

References m_mac, and NS_LOG_FUNCTION.

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

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

References m_phy, and NS_LOG_FUNCTION.

Referenced by ns3::LteUePhy::SubframeIndication().

+ Here is the caller graph for this function:

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

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

References m_rrc, and NS_LOG_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 166 of file lte-ue-net-device.cc.

References m_targetEnb, and 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.

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

References m_mac, m_phy, m_rrc, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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.

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

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

+ Here is the call 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 155 of file lte-ue-net-device.cc.

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

+ Here is the call graph for this 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 124 of file lte-ue-net-device.cc.

References NS_LOG_FUNCTION.

Referenced by DoStart().

+ Here is the caller graph for this function:

Member Data Documentation

uint64_t ns3::LteUeNetDevice::m_imsi
private

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

Referenced by GetImsi(), and LteUeNetDevice().

uint64_t ns3::LteUeNetDevice::m_imsiCounter = 0
staticprivate

Definition at line 115 of file lte-ue-net-device.h.

Referenced by LteUeNetDevice().

Ptr<LteUeMac> ns3::LteUeNetDevice::m_mac
private

Definition at line 110 of file lte-ue-net-device.h.

Referenced by DoDispose(), DoStart(), GetMac(), GetTypeId(), and LteUeNetDevice().

Ptr<LteUePhy> ns3::LteUeNetDevice::m_phy
private

Definition at line 111 of file lte-ue-net-device.h.

Referenced by DoDispose(), DoStart(), GetPhy(), GetTypeId(), LteUeNetDevice(), and SetTargetEnb().

Ptr<LteUeRrc> ns3::LteUeNetDevice::m_rrc
private

Definition at line 112 of file lte-ue-net-device.h.

Referenced by DoDispose(), DoStart(), GetRrc(), GetTypeId(), LteUeNetDevice(), and Send().

Ptr<LteEnbNetDevice> ns3::LteUeNetDevice::m_targetEnb
private

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

Referenced by DoDispose(), GetTargetEnb(), and SetTargetEnb().


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