This helper class allows to easily create a topology with eNBs grouped in three-sector sites layed out on an hexagonal grid. More...

#include <lte-hex-grid-enb-topology-helper.h>

Inheritance diagram for ns3::LteHexGridEnbTopologyHelper:

Collaboration diagram for ns3::LteHexGridEnbTopologyHelper:

Public Member Functions
	LteHexGridEnbTopologyHelper (void)

virtual	~LteHexGridEnbTopologyHelper (void)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

void	SetLteHelper (Ptr< LteHelper > h)
	Set the LteHelper to be used to actually create the EnbNetDevices. More...

NetDeviceContainer	SetPositionAndInstallEnbDevice (NodeContainer c)
	Position the nodes on a hex grid and install the corresponding EnbNetDevices with antenna boresight configured properly. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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::Object
static TypeId	GetTypeId (void)
	Register this type. More...

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

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
double	m_d

uint32_t	m_gridWidth

Ptr< LteHelper >	m_lteHelper

double	m_offset

uint32_t	m_siteHeight

double	m_xMin

double	m_yMin

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

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

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

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

This helper class allows to easily create a topology with eNBs grouped in three-sector sites layed out on an hexagonal grid.

Doxygen introspection did not find any typical Config paths.

The layout is done row-wise.

Attributes

InterSiteDistance: The distance [m] between nearby sites
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 500
- Flags: construct write read
SectorOffset: The offset [m] in the position for the node of each sector with respect to the center of the three-sector site
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.5
- Flags: construct write read
SiteHeight: The height [m] of each site
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 30
- Flags: construct write read
MinX: The x coordinate where the hex grid starts.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
MinY: The y coordinate where the hex grid starts.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
GridWidth: The number of sites in even rows (odd rows will have one additional site).
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 36 of file lte-hex-grid-enb-topology-helper.h.

Constructor & Destructor Documentation

ns3::LteHexGridEnbTopologyHelper::LteHexGridEnbTopologyHelper ( void )

Definition at line 37 of file lte-hex-grid-enb-topology-helper.cc.

References NS_LOG_FUNCTION.

ns3::LteHexGridEnbTopologyHelper::~LteHexGridEnbTopologyHelper ( void )

virtual

Definition at line 42 of file lte-hex-grid-enb-topology-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

Definition at line 87 of file lte-hex-grid-enb-topology-helper.cc.

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

Here is the call graph for this function:

TypeId ns3::LteHexGridEnbTopologyHelper::GetTypeId ( void )

static

Definition at line 47 of file lte-hex-grid-enb-topology-helper.cc.

References m_d, m_gridWidth, m_offset, m_siteHeight, m_xMin, m_yMin, and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::LteHexGridEnbTopologyHelper::SetLteHelper ( Ptr< LteHelper > h )

Set the LteHelper to be used to actually create the EnbNetDevices.

Note: if no EpcHelper is ever set, then LteHexGridEnbTopologyHelper will default to creating an LTE-only simulation with no EPC, using LteRlcSm as the RLC model, and without supporting any IP networking. In other words, it will be a radio-level simulation involving only LTE PHY and MAC and the FF Scheduler, with a saturation traffic model for the RLC.

Parameters