A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::LteHexGridEnbTopologyHelper Class Reference

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

+ Inheritance diagram for ns3::LteHexGridEnbTopologyHelper:

Public Member Functions

virtual void DoDispose (void)
 
void SetLteHelper (Ptr< LteHelper > h)
 
NetDeviceContainer SetPositionAndInstallEnbDevice (NodeContainer c)
 
- Public Member Functions inherited from ns3::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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

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)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

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

Doxygen introspection did not find any typical Config paths.

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).

No TraceSources are defined for this type.

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

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.

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
ha pointer to the EpcHelper to be used

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

References NS_LOG_FUNCTION.

NetDeviceContainer ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice ( NodeContainer  c)

Position the nodes on a hex grid and install the corresponding EnbNetDevices with antenna boresight configured properly

Parameters
cthe node container where the devices are to be installed
Returns
the NetDeviceContainer with the newly created devices

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

References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Get(), ns3::NodeContainer::GetN(), ns3::Object::GetObject(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::MobilityModel::SetPosition().

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