The LteUeNetDevice class implements the UE net device. More...
#include "lte-ue-net-device.h"
Public Member Functions | |
LteUeNetDevice () | |
~LteUeNetDevice () override | |
void | DoDispose () override |
Destructor implementation. | |
std::map< uint8_t, Ptr< ComponentCarrierUe > > | GetCcMap () |
Get the ComponentCarrier Map for the UE. | |
Ptr< LteUeComponentCarrierManager > | GetComponentCarrierManager () const |
Get the componentn carrier manager. | |
uint32_t | GetCsgId () const |
Returns the CSG ID the UE is currently a member of. | |
uint32_t | GetDlEarfcn () const |
uint64_t | GetImsi () const |
Get the IMSI. | |
Ptr< LteUeMac > | GetMac () const |
Get the MAC. | |
Ptr< EpcUeNas > | GetNas () const |
Get the NAS. | |
Ptr< LteUePhy > | GetPhy () const |
Get the Phy. | |
Ptr< LteUeRrc > | GetRrc () const |
Get the RRC. | |
Ptr< LteEnbNetDevice > | GetTargetEnb () |
Get the target eNB where the UE is registered. | |
bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override |
void | SetCcMap (std::map< uint8_t, Ptr< ComponentCarrierUe > > ccm) |
Set the ComponentCarrier Map for the UE. | |
void | SetCsgId (uint32_t csgId) |
Enlist the UE device as a member of a particular CSG. | |
void | SetDlEarfcn (uint32_t earfcn) |
void | SetTargetEnb (Ptr< LteEnbNetDevice > enb) |
Set the target eNB where the UE is registered. | |
Public Member Functions inherited from ns3::LteNetDevice | |
LteNetDevice () | |
LteNetDevice (const LteNetDevice &)=delete | |
~LteNetDevice () override | |
void | AddLinkChangeCallback (Callback< void > callback) override |
Address | GetAddress () const override |
Address | GetBroadcast () const override |
Ptr< Channel > | GetChannel () const override |
uint32_t | GetIfIndex () const override |
uint16_t | GetMtu () const override |
Address | GetMulticast (Ipv4Address addr) const override |
Make and return a MAC multicast address using the provided multicast group. | |
Address | GetMulticast (Ipv6Address addr) const override |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
Ptr< Node > | GetNode () const override |
bool | IsBridge () const override |
Return true if the net device is acting as a bridge. | |
bool | IsBroadcast () const override |
bool | IsLinkUp () const override |
bool | IsMulticast () const override |
bool | IsPointToPoint () const override |
Return true if the net device is on a point-to-point link. | |
bool | NeedsArp () const override |
LteNetDevice & | operator= (const LteNetDevice &)=delete |
void | Receive (Ptr< Packet > p) |
receive a packet from the lower layers in order to forward it to the upper layers | |
bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override |
void | SetAddress (Address address) override |
Set the address of this interface. | |
void | SetIfIndex (const uint32_t index) override |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) override |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
bool | SupportsSendFrom () const override |
Public Member Functions inherited from ns3::NetDevice | |
~NetDevice () override | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::LteNetDevice | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoInitialize () override |
Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Member Functions | |
void | UpdateConfig () |
Propagate attributes and configuration to sub-modules. | |
Private Attributes | |
std::map< uint8_t, Ptr< ComponentCarrierUe > > | m_ccMap |
CC map. | |
Ptr< LteUeComponentCarrierManager > | m_componentCarrierManager |
the component carrier manager | |
uint32_t | m_csgId |
the CSG ID | |
uint32_t | m_dlEarfcn |
downlink carrier frequency | |
uint64_t | m_imsi |
the IMSI | |
bool | m_isConstructed |
is constructed? | |
Ptr< EpcUeNas > | m_nas |
the NAS | |
Ptr< LteUeRrc > | m_rrc |
the RRC | |
Ptr< LteEnbNetDevice > | m_targetEnb |
target ENB | |
Additional Inherited Members | |
Public Types inherited from ns3::NetDevice | |
typedef void(* | LinkChangeTracedCallback) () |
TracedCallback signature for link changed event. | |
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 &, 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 |
receive callback | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
The LteUeNetDevice class implements the UE net device.
ns3::LteUeNetDevice is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 216 bytes (on a 64-bit architecture).
Definition at line 45 of file lte-ue-net-device.h.
ns3::LteUeNetDevice::LteUeNetDevice | ( | ) |
Definition at line 104 of file lte-ue-net-device.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 110 of file lte-ue-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden 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 116 of file lte-ue-net-device.cc.
References ns3::LteNetDevice::DoDispose(), m_ccMap, m_componentCarrierManager, m_nas, m_rrc, m_targetEnb, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
Initialize() implementation.
This method is called only once by Initialize(). If the user calls 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 253 of file lte-ue-net-device.cc.
References m_ccMap, m_isConstructed, m_rrc, NS_LOG_FUNCTION, and UpdateConfig().
std::map< uint8_t, Ptr< ComponentCarrierUe > > ns3::LteUeNetDevice::GetCcMap | ( | ) |
Get the ComponentCarrier Map for the UE.
Definition at line 241 of file lte-ue-net-device.cc.
References m_ccMap.
Ptr< LteUeComponentCarrierManager > ns3::LteUeNetDevice::GetComponentCarrierManager | ( | ) | const |
Get the componentn carrier manager.
Definition at line 177 of file lte-ue-net-device.cc.
References m_componentCarrierManager, and NS_LOG_FUNCTION.
uint32_t ns3::LteUeNetDevice::GetCsgId | ( | ) | const |
Returns the CSG ID the UE is currently a member of.
Definition at line 212 of file lte-ue-net-device.cc.
References m_csgId, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
uint32_t ns3::LteUeNetDevice::GetDlEarfcn | ( | ) | const |
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 198 of file lte-ue-net-device.cc.
References m_dlEarfcn, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
uint64_t ns3::LteUeNetDevice::GetImsi | ( | ) | const |
Get the IMSI.
Definition at line 191 of file lte-ue-net-device.cc.
References m_imsi, and NS_LOG_FUNCTION.
Referenced by ns3::LteStatsCalculator::FindImsiFromLteNetDevice().
Get the MAC.
Definition at line 156 of file lte-ue-net-device.cc.
References m_ccMap, and NS_LOG_FUNCTION.
Get the NAS.
Definition at line 184 of file lte-ue-net-device.cc.
References m_nas, and NS_LOG_FUNCTION.
Get the Phy.
Definition at line 170 of file lte-ue-net-device.cc.
References m_ccMap, and NS_LOG_FUNCTION.
Referenced by LteUplinkClosedLoopPowerControlAbsoluteModeTestCase::DoRun(), LteUplinkClosedLoopPowerControlAccumulatedModeTestCase::DoRun(), and LteUplinkOpenLoopPowerControlTestCase::DoRun().
Get the RRC.
Definition at line 163 of file lte-ue-net-device.cc.
References m_rrc, and NS_LOG_FUNCTION.
Ptr< LteEnbNetDevice > ns3::LteUeNetDevice::GetTargetEnb | ( | ) |
Get the target eNB where the UE is registered.
Definition at line 234 of file lte-ue-net-device.cc.
References m_targetEnb, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 52 of file lte-ue-net-device.cc.
References GetCsgId(), GetDlEarfcn(), m_ccMap, m_componentCarrierManager, m_imsi, m_nas, m_rrc, ns3::MakeObjectMapAccessor(), ns3::MakeObjectMapChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetCsgId(), SetDlEarfcn(), and ns3::TypeId::SetParent().
Referenced by ns3::LteHelper::LteHelper().
|
overridevirtual |
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
Implements ns3::NetDevice.
Definition at line 268 of file lte-ue-net-device.cc.
References m_nas, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::Ipv4L3Protocol::PROT_NUMBER, and ns3::Ipv6L3Protocol::PROT_NUMBER.
void ns3::LteUeNetDevice::SetCcMap | ( | std::map< uint8_t, Ptr< ComponentCarrierUe > > | ccm | ) |
Set the ComponentCarrier Map for the UE.
ccm | the map of ComponentCarrierUe |
Definition at line 247 of file lte-ue-net-device.cc.
References m_ccMap.
void ns3::LteUeNetDevice::SetCsgId | ( | uint32_t | csgId | ) |
Enlist the UE device as a member of a particular CSG.
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.
Definition at line 219 of file lte-ue-net-device.cc.
References m_csgId, NS_LOG_FUNCTION, and UpdateConfig().
Referenced by GetTypeId().
void ns3::LteUeNetDevice::SetDlEarfcn | ( | uint32_t | earfcn | ) |
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 205 of file lte-ue-net-device.cc.
References m_dlEarfcn, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::LteUeNetDevice::SetTargetEnb | ( | Ptr< LteEnbNetDevice > | enb | ) |
Set the target eNB where the UE is registered.
enb |
Definition at line 227 of file lte-ue-net-device.cc.
References m_targetEnb, and NS_LOG_FUNCTION.
|
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 135 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().
|
private |
CC map.
Definition at line 186 of file lte-ue-net-device.h.
Referenced by DoDispose(), DoInitialize(), GetCcMap(), GetMac(), GetPhy(), GetTypeId(), and SetCcMap().
|
private |
the component carrier manager
Definition at line 178 of file lte-ue-net-device.h.
Referenced by DoDispose(), GetComponentCarrierManager(), and GetTypeId().
|
private |
the CSG ID
Definition at line 184 of file lte-ue-net-device.h.
Referenced by GetCsgId(), SetCsgId(), and UpdateConfig().
|
private |
downlink carrier frequency
Definition at line 182 of file lte-ue-net-device.h.
Referenced by GetDlEarfcn(), and SetDlEarfcn().
|
private |
the IMSI
Definition at line 180 of file lte-ue-net-device.h.
Referenced by GetImsi(), GetTypeId(), and UpdateConfig().
|
private |
is constructed?
Definition at line 161 of file lte-ue-net-device.h.
Referenced by DoInitialize(), and UpdateConfig().
the NAS
Definition at line 177 of file lte-ue-net-device.h.
Referenced by DoDispose(), GetNas(), GetTypeId(), Send(), and UpdateConfig().
the RRC
Definition at line 176 of file lte-ue-net-device.h.
Referenced by DoDispose(), DoInitialize(), GetRrc(), GetTypeId(), and UpdateConfig().
|
private |
target ENB
Definition at line 174 of file lte-ue-net-device.h.
Referenced by DoDispose(), GetTargetEnb(), and SetTargetEnb().