A Discrete-Event Network Simulator
API
Static Public Member Functions | List of all members
ns3::BuildingsHelper Class Reference

#include "buildings-helper.h"

Static Public Member Functions

static void Install (Ptr< Node > node)
 Install the MobilityBuildingInfo to a node. More...
 
static void Install (NodeContainer c)
 Install the MobilityBuildingInfo to the set of nodes in a NodeContainer. More...
 
static void MakeConsistent (Ptr< MobilityModel > bmm)
 Make the given mobility model consistent, by determining whether its position falls inside any of the building in BuildingList, and updating accordingly the BuildingInfo aggregated with the MobilityModel. More...
 
static void MakeMobilityModelConsistent ()
 This method goes through the whole NodeList and, for each node in the list, calls BuildingsHelper::MakeConsistent() passing to it the MobilityModel of that node. More...
 

Detailed Description

Definition at line 36 of file buildings-helper.h.

Member Function Documentation

◆ Install() [1/2]

void ns3::BuildingsHelper::Install ( Ptr< Node node)
static

Install the MobilityBuildingInfo to a node.

Parameters
nodethe mobility model of the node to be updated

Definition at line 47 of file buildings-helper.cc.

References ns3::Object::AggregateObject(), ns3::Node::GetId(), ns3::Object::GetObject(), and NS_ABORT_MSG_UNLESS.

Referenced by Install().

◆ Install() [2/2]

void ns3::BuildingsHelper::Install ( NodeContainer  c)
static

Install the MobilityBuildingInfo to the set of nodes in a NodeContainer.

Parameters
cthe NodeContainer including the nodes to be updated

Definition at line 37 of file buildings-helper.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), and Install().

◆ MakeConsistent()

void ns3::BuildingsHelper::MakeConsistent ( Ptr< MobilityModel bmm)
static

Make the given mobility model consistent, by determining whether its position falls inside any of the building in BuildingList, and updating accordingly the BuildingInfo aggregated with the MobilityModel.

Parameters
bmmthe mobility model to be made consistent

Definition at line 79 of file buildings-helper.cc.

References ns3::BuildingList::Begin(), ns3::BuildingList::End(), ns3::Object::GetObject(), ns3::MobilityModel::GetPosition(), NS_ABORT_MSG_UNLESS, and NS_LOG_LOGIC().

Referenced by MakeMobilityModelConsistent(), ns3::RadioEnvironmentMapHelper::RunOneIteration(), and ns3::SameRoomPositionAllocator::SameRoomPositionAllocator().

◆ MakeMobilityModelConsistent()

void ns3::BuildingsHelper::MakeMobilityModelConsistent ( )
static

This method goes through the whole NodeList and, for each node in the list, calls BuildingsHelper::MakeConsistent() passing to it the MobilityModel of that node.

Definition at line 62 of file buildings-helper.cc.

References ns3::NodeList::Begin(), ns3::NodeList::End(), ns3::Object::GetObject(), MakeConsistent(), NS_ABORT_MSG_UNLESS, and NS_LOG_FUNCTION_NOARGS.


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