ns-3
ns3::LteHexGridEnbTopologyHelper Class Reference

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

Inheritance diagram for ns3::LteHexGridEnbTopologyHelper:
Collaboration diagram for ns3::LteHexGridEnbTopologyHelper:

List of all members.

Public Member Functions

virtual void DoDispose (void)
void SetLteHelper (Ptr< LteHelper > h)
NetDeviceContainer SetPositionAndInstallEnbDevice (NodeContainer c)
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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::LteHexGridEnbTopologyHelper.

Additional Inherited Members

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

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.


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.

References NS_LOG_FUNCTION.

TypeId ns3::LteHexGridEnbTopologyHelper::GetTypeId ( void  )
static

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

Attributes defined for this type:

  • 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 defined for this type.

Reimplemented from ns3::Object.

References ns3::TypeId::SetParent().

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

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

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


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