#include <lte-phy.h>

Inheritance diagram for ns3::LtePhy:

Collaboration diagram for ns3::LtePhy:

Public Member Functions
	LtePhy ()
	LtePhy (Ptr< LteSpectrumPhy > dlPhy, Ptr< LteSpectrumPhy > ulPhy)
virtual	~LtePhy ()
virtual Ptr< SpectrumValue >	CreateTxPowerSpectralDensity ()=0
	Compute the TX Power Spectral Density.
void	DoDispose ()
virtual void	DoSendMacPdu (Ptr< Packet > p)=0
	Queue the MAC PDU to be sent (according to m_macChTtiDelay)
void	DoSetBandwidth (uint8_t ulBandwidth, uint8_t dlBandwidth)
void	DoSetCellId (uint16_t cellId)
virtual void	DoSetDownlinkSubChannels ()
	do some operation after the set of a list of DL sub channels
virtual void	DoSetEarfcn (uint16_t dlEarfcn, uint16_t ulEarfcn)
virtual void	DoSetUplinkSubChannels ()
	do some operation after the set of a list of UL sub channels
virtual void	GenerateCqiReport (const SpectrumValue &sinr)=0
std::list< Ptr < IdealControlMessage > >	GetControlMessages (void)
Ptr< LteNetDevice >	GetDevice ()
	Get the device where the phy layer is attached.
Ptr< LteSpectrumPhy >	GetDownlinkSpectrumPhy ()
std::vector< int >	GetDownlinkSubChannels (void)
	get a list of sub channel to use in the downlink
Ptr< PacketBurst >	GetPacketBurst (void)
uint8_t	GetRbgSize (void) const
double	GetTti (void) const
Ptr< LteSpectrumPhy >	GetUplinkSpectrumPhy ()
std::vector< int >	GetUplinkSubChannels (void)
	get a list of sub channel to use in the downlink
virtual void	ReceiveIdealControlMessage (Ptr< IdealControlMessage > msg)=0
	Receive SendIdealControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel.
void	SetControlMessages (Ptr< IdealControlMessage > m)
void	SetDevice (Ptr< LteNetDevice > d)
	Set the device where the phy layer is attached.
void	SetDownlinkChannel (Ptr< SpectrumChannel > c)
void	SetDownlinkSubChannels (std::vector< int > mask)
	set a list of sub channel to use in the downlink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)
void	SetMacPdu (Ptr< Packet > p)
void	SetTti (double tti)
void	SetUplinkChannel (Ptr< SpectrumChannel > c)
void	SetUplinkSubChannels (std::vector< int > mask)
	set a list of sub channel to use in the uplink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)
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
SimpleRefCount &	operator= (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::LtePhy.

Protected Attributes
uint16_t	m_cellId
std::vector< std::list< Ptr < IdealControlMessage > > >	m_controlMessagesQueue
uint8_t	m_dlBandwidth
uint16_t	m_dlEarfcn
Ptr< LteSpectrumPhy >	m_downlinkSpectrumPhy
std::vector< int >	m_listOfDownlinkSubchannel
std::vector< int >	m_listOfUplinkSubchannel
uint8_t	m_macChTtiDelay
Ptr< LteNetDevice >	m_netDevice
double	m_noiseFigure
std::vector< Ptr< PacketBurst > >	m_packetBurstQueue
uint8_t	m_rbgSize
double	m_tti
double	m_txPower
uint8_t	m_ulBandwidth
uint16_t	m_ulEarfcn
Ptr< LteSpectrumPhy >	m_uplinkSpectrumPhy

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

The LtePhy models the physical layer of LTE. It is composed by two LteSpectrumPhy, one for the downlink and one for the uplink.

Definition at line 50 of file lte-phy.h.

Constructor & Destructor Documentation

ns3::LtePhy::LtePhy ( )

Warning: the default constructor should not be used

Definition at line 38 of file lte-phy.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

ns3::LtePhy::LtePhy	(	Ptr< LteSpectrumPhy >	dlPhy,
		Ptr< LteSpectrumPhy >	ulPhy
	)

Parameters

dlPhy	the downlink LteSpectrumPhy instance
ulPhy	the uplink LteSpectrumPhy instance

Definition at line 44 of file lte-phy.cc.

References NS_LOG_FUNCTION.

ns3::LtePhy::~LtePhy ( )

virtual

Definition at line 67 of file lte-phy.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

virtual Ptr<SpectrumValue> ns3::LtePhy::CreateTxPowerSpectralDensity ( )

pure virtual

Compute the TX Power Spectral Density.

Returns: a pointer to a newly allocated SpectrumValue representing the TX Power Spectral Density in W/Hz for each Resource Block

Implemented in ns3::LteEnbPhy, ns3::LteUePhy, and ns3::LteTestUePhy.

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

Reimplemented in ns3::LteUePhy, ns3::LteEnbPhy, and ns3::LteTestUePhy.

Definition at line 73 of file lte-phy.cc.

References ns3::Object::Dispose(), m_controlMessagesQueue, m_downlinkSpectrumPhy, m_netDevice, m_packetBurstQueue, m_uplinkSpectrumPhy, and NS_LOG_FUNCTION.

Here is the call graph for this function:

virtual void ns3::LtePhy::DoSendMacPdu ( Ptr< Packet > p )

pure virtual

Queue the MAC PDU to be sent (according to m_macChTtiDelay)

Parameters

p	the MAC PDU to sent

Implemented in ns3::LteEnbPhy, ns3::LteUePhy, and ns3::LteTestUePhy.

void ns3::LtePhy::DoSetBandwidth	(	uint8_t	ulBandwidth,
		uint8_t	dlBandwidth
	)

Parameters

ulBandwidth	the UL bandwidth in RB
dlBandwidth	the DL bandwidth in RB

Definition at line 191 of file lte-phy.cc.

References m_dlBandwidth, m_rbgSize, m_ulBandwidth, and ns3::Type0AllocationRbg.

Referenced by ns3::LteHelper::Attach(), ns3::EnbMemberLteEnbPhySapProvider::SetBandwidth(), ns3::UeMemberLteUePhySapProvider::SetBandwidth(), and ns3::LteEnbNetDevice::UpdateConfig().

Here is the caller graph for this function:

void ns3::LtePhy::DoSetCellId ( uint16_t cellId )

Parameters

cellId the Cell Identifier

Definition at line 281 of file lte-phy.cc.

References m_cellId, m_downlinkSpectrumPhy, m_uplinkSpectrumPhy, and ns3::LteSpectrumPhy::SetCellId().

Referenced by ns3::EnbMemberLteEnbPhySapProvider::SetCellId(), ns3::LteUeNetDevice::SetTargetEnb(), and ns3::LteEnbNetDevice::UpdateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LtePhy::DoSetDownlinkSubChannels ( )

virtual

do some operation after the set of a list of DL sub channels

Reimplemented in ns3::LteEnbPhy.

Definition at line 138 of file lte-phy.cc.

References NS_LOG_FUNCTION.

Referenced by SetDownlinkSubChannels().

Here is the caller graph for this function:

void ns3::LtePhy::DoSetEarfcn	(	uint16_t	dlEarfcn,
		uint16_t	ulEarfcn
	)

virtual

Parameters

dlEarfcn	the carrier frequency (EARFCN) in downlink
ulEarfcn	the carrier frequency (EARFCN) in downlink

Definition at line 213 of file lte-phy.cc.

References m_dlEarfcn, and m_ulEarfcn.

Referenced by ns3::LteHelper::Attach(), and ns3::LteEnbNetDevice::UpdateConfig().

Here is the caller graph for this function:

void ns3::LtePhy::DoSetUplinkSubChannels ( )

virtual

do some operation after the set of a list of UL sub channels

Reimplemented in ns3::LteUePhy.

Definition at line 154 of file lte-phy.cc.

References NS_LOG_FUNCTION.

Referenced by SetUplinkSubChannels().

Here is the caller graph for this function:

virtual void ns3::LtePhy::GenerateCqiReport ( const SpectrumValue & sinr )

pure virtual

generate a CQI report based on the given SINR

Parameters

sinr	the SINR vs frequency measured by the device

Implemented in ns3::LteEnbPhy, ns3::LteUePhy, and ns3::LteTestUePhy.

Referenced by ns3::LteCqiSinrChunkProcessor::End().

Here is the caller graph for this function:

std::list< Ptr< IdealControlMessage > > ns3::LtePhy::GetControlMessages ( void )

Returns: the list of control messages to be sent

Definition at line 259 of file lte-phy.cc.

References m_controlMessagesQueue.

Referenced by ns3::LteEnbPhy::StartSubFrame(), and ns3::LteUePhy::SubframeIndication().

Here is the caller graph for this function:

Ptr< LteNetDevice > ns3::LtePhy::GetDevice ( void )

Get the device where the phy layer is attached.

Returns: the pointer to the device

Definition at line 95 of file lte-phy.cc.

References m_netDevice, and NS_LOG_FUNCTION.

Referenced by ns3::LteUePhy::DoSendIdealControlMessage(), ns3::LteUePhy::GenerateCqiReport(), and ns3::LteUePhy::SubframeIndication().

Here is the caller graph for this function:

Ptr< LteSpectrumPhy > ns3::LtePhy::GetDownlinkSpectrumPhy ( )

Returns: a pointer to the LteSpectrumPhy instance that manages the downlink

Definition at line 102 of file lte-phy.cc.

References m_downlinkSpectrumPhy.

Referenced by ns3::LteHelper::AssignStreams(), ns3::LteHelper::Attach(), ns3::AnimationInterface::ConnectLteEnb(), ns3::AnimationInterface::ConnectLteUe(), ns3::LteLinkAdaptationTestCase::DoRun(), ns3::LteEnbAntennaTestCase::DoRun(), and ns3::LteInterferenceTestCase::DoRun().

Here is the caller graph for this function:

std::vector< int > ns3::LtePhy::GetDownlinkSubChannels ( void )

get a list of sub channel to use in the downlink

Returns

Definition at line 161 of file lte-phy.cc.

References m_listOfDownlinkSubchannel, and NS_LOG_FUNCTION.

Referenced by ns3::LteEnbPhy::CreateTxPowerSpectralDensity().

Here is the caller graph for this function:

Ptr< PacketBurst > ns3::LtePhy::GetPacketBurst ( void )

Returns: the packet burst to be sent

Definition at line 232 of file lte-phy.cc.

References m_packetBurstQueue.

Referenced by ns3::LteEnbPhy::StartSubFrame(), and ns3::LteUePhy::SubframeIndication().

Here is the caller graph for this function:

uint8_t ns3::LtePhy::GetRbgSize ( void ) const

Returns: the RB gruop size according to the bandwidth

Definition at line 220 of file lte-phy.cc.

References m_rbgSize.

Referenced by ns3::LteUePhy::CreateDlCqiFeedbackMessage(), ns3::LteUePhy::ReceiveIdealControlMessage(), and ns3::LteEnbPhy::StartSubFrame().

Here is the caller graph for this function:

double ns3::LtePhy::GetTti ( void ) const

Returns: transmission time interval

Definition at line 184 of file lte-phy.cc.

References m_tti, and NS_LOG_FUNCTION.

Referenced by ns3::LteEnbPhy::StartSubFrame().

Here is the caller graph for this function:

TypeId ns3::LtePhy::GetTypeId ( void )

static

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

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::LteUePhy, ns3::LteEnbPhy, and ns3::LteTestUePhy.

Definition at line 58 of file lte-phy.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

Ptr< LteSpectrumPhy > ns3::LtePhy::GetUplinkSpectrumPhy ( )

Returns: a pointer to the LteSpectrumPhy instance that manages the uplink

Definition at line 108 of file lte-phy.cc.

References m_uplinkSpectrumPhy.

Referenced by ns3::LteHelper::AssignStreams(), ns3::AnimationInterface::ConnectLteEnb(), ns3::AnimationInterface::ConnectLteUe(), ns3::LteEnbAntennaTestCase::DoRun(), and ns3::LteInterferenceTestCase::DoRun().

Here is the caller graph for this function:

std::vector< int > ns3::LtePhy::GetUplinkSubChannels ( void )

get a list of sub channel to use in the downlink

Returns

Definition at line 169 of file lte-phy.cc.

References m_listOfUplinkSubchannel, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

virtual void ns3::LtePhy::ReceiveIdealControlMessage ( Ptr< IdealControlMessage > msg )

pure virtual

Receive SendIdealControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel.

Parameters

msg	the Ideal Control Message to receive

Implemented in ns3::LteUePhy, ns3::LteEnbPhy, and ns3::LteTestUePhy.

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

Here is the caller graph for this function:

void ns3::LtePhy::SetControlMessages ( Ptr< IdealControlMessage > m )

Parameters

m	the control message to be sent

Definition at line 251 of file lte-phy.cc.

References m_controlMessagesQueue.

Referenced by ns3::LteEnbPhy::DoSendIdealControlMessage(), and ns3::LteUePhy::DoSendIdealControlMessage().

Here is the caller graph for this function:

void ns3::LtePhy::SetDevice ( Ptr< LteNetDevice > d )

Set the device where the phy layer is attached.

Parameters

d	the device

Definition at line 87 of file lte-phy.cc.

References m_netDevice, and NS_LOG_FUNCTION.

void ns3::LtePhy::SetDownlinkChannel ( Ptr< SpectrumChannel > c )

Set the downlink channel

Parameters

c	the downlink channel

Definition at line 115 of file lte-phy.cc.

References m_downlinkSpectrumPhy, NS_LOG_FUNCTION, and ns3::LteSpectrumPhy::SetChannel().

Here is the call graph for this function:

void ns3::LtePhy::SetDownlinkSubChannels ( std::vector< int > mask )

set a list of sub channel to use in the downlink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)

Parameters

mask	a vector of intefer values. Each elements of this vector carries information about the corresponding DL sub channel. If the i-th value of mask is equal to 1 (0) it means that the corresponding sub channel is used (not used) for the downlink.

Definition at line 129 of file lte-phy.cc.

References DoSetDownlinkSubChannels(), m_listOfDownlinkSubchannel, and NS_LOG_FUNCTION.

Referenced by ns3::LteEnbPhy::StartSubFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LtePhy::SetMacPdu ( Ptr< Packet > p )

Parameters

p	queue MAC PDU to be sent

Definition at line 226 of file lte-phy.cc.

References m_packetBurstQueue.

Referenced by ns3::LteEnbPhy::DoSendMacPdu(), and ns3::LteUePhy::DoSendMacPdu().

Here is the caller graph for this function:

void ns3::LtePhy::SetTti ( double tti )

Parameters

tti	transmission time interval

Definition at line 176 of file lte-phy.cc.

References m_tti, and NS_LOG_FUNCTION.

void ns3::LtePhy::SetUplinkChannel ( Ptr< SpectrumChannel > c )

Set the uplink channel

Parameters

c	the uplink channel

Definition at line 122 of file lte-phy.cc.

References m_uplinkSpectrumPhy, NS_LOG_FUNCTION, and ns3::LteSpectrumPhy::SetChannel().

Here is the call graph for this function:

void ns3::LtePhy::SetUplinkSubChannels ( std::vector< int > mask )

set a list of sub channel to use in the uplink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)

Parameters

mask	a vector of intefer values. Each elements of this vector carries information about the corresponding UL sub channel. If the i-th value of mask is equal to 1 (0) it means that the corresponding sub channel is used (not used) for the uplink.

Definition at line 145 of file lte-phy.cc.

References DoSetUplinkSubChannels(), m_listOfUplinkSubchannel, and NS_LOG_FUNCTION.

Here is the call graph for this function: