#include "box.h"

Collaboration diagram for ns3::Box:

Public Types
enum	Side { RIGHT , LEFT , TOP , BOTTOM , UP , DOWN }
	Enum class to specify sides of a box. More...

Public Member Functions
	Box ()
	Create a zero-sized box located at coordinates (0.0,0.0,0.0) More...

	Box (double _xMin, double _xMax, double _yMin, double _yMax, double _zMin, double _zMax)

Vector	CalculateIntersection (const Vector &current, const Vector &speed) const

Side	GetClosestSide (const Vector &position) const

bool	IsInside (const Vector &position) const

bool	IsIntersect (const Vector &l1, const Vector &l2) const
	Checks if a line-segment between position l1 and position l2 intersects a box. More...

Public Attributes
double	xMax
	The x coordinate of the right bound of the box. More...

double	xMin
	The x coordinate of the left bound of the box. More...

double	yMax
	The y coordinate of the top bound of the box. More...

double	yMin
	The y coordinate of the bottom bound of the box. More...

double	zMax
	The z coordinate of the up bound of the box. More...

double	zMin
	The z coordinate of the down bound of the box. More...

Detailed Description

a 3d box

See also: attribute_Box

Definition at line 34 of file box.h.

Member Enumeration Documentation

◆ Side

enum ns3::Box::Side

Enum class to specify sides of a box.

Enumerator
RIGHT
LEFT
TOP
BOTTOM
UP
DOWN

Definition at line 40 of file box.h.

Constructor & Destructor Documentation

◆ Box() [1/2]

ns3::Box::Box	(	double	_xMin,
		double	_xMax,
		double	_yMin,
		double	_yMax,
		double	_zMin,
		double	_zMax
	)

Parameters

_xMin	x coordinates of left boundary.
_xMax	x coordinates of right boundary.
_yMin	y coordinates of bottom boundary.
_yMax	y coordinates of top boundary.
_zMin	z coordinates of down boundary.
_zMax	z coordinates of up boundary.

Create a box.

Definition at line 33 of file box.cc.

◆ Box() [2/2]

ns3::Box::Box ( )

Create a zero-sized box located at coordinates (0.0,0.0,0.0)

Definition at line 43 of file box.cc.

Member Function Documentation

◆ CalculateIntersection()

Vector ns3::Box::CalculateIntersection	(	const Vector &	current,
		const Vector &	speed
	)		const

Parameters

current	the current position
speed	the current speed

Returns: the intersection point between the rectangle and the current+speed vector.

This method assumes that the current position is located inside the cube and checks for this with an assert. This method compares only the x and y coordinates of the input position and speed. It ignores the z coordinate.

Definition at line 108 of file box.cc.

References IsInside(), NS_ASSERT, xMax, xMin, yMax, and yMin.

Here is the call graph for this function:

◆ GetClosestSide()

Box::Side ns3::Box::GetClosestSide ( const Vector & position ) const

Parameters

position the position to test.

Returns: the side of the cube the input position is closest to.

This method compares the x, y, and z coordinates of the input position.

Definition at line 61 of file box.cc.

References BOTTOM, DOWN, LEFT, min, RIGHT, TOP, UP, xMax, yMax, and zMax.

◆ IsInside()

bool ns3::Box::IsInside ( const Vector & position ) const

Parameters

position the position to test.

Returns: true if the input position is located within the box, false otherwise.

This method compares the x, y, and z coordinates of the input position.

Definition at line 54 of file box.cc.

References xMax, xMin, yMax, yMin, zMax, and zMin.

Referenced by CalculateIntersection(), ns3::RandomWalk2dOutdoorMobilityModel::CalculateIntersectionFromOutside(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::Building::IsInside(), and IsIntersect().

Here is the caller graph for this function:

◆ IsIntersect()

bool ns3::Box::IsIntersect	(	const Vector &	l1,
		const Vector &	l2
	)		const

Checks if a line-segment between position l1 and position l2 intersects a box.

This method considers all the three coordinates, i.e., x, y, and z. This function was developed by NYU Wireless and is based on the algorithm described here http://www.3dkingdoms.com/weekly/weekly.php?a=21. Reference: Menglei Zhang, Michele Polese, Marco Mezzavilla, Sundeep Rangan, Michele Zorzi. "ns-3 Implementation of the 3GPP MIMO Channel Model for Frequency Spectrum above 6 GHz". In Proceedings of the Workshop on ns-3 (WNS3 '17). 2017.

Parameters

l1	position
l2	position

Returns: true if there is a intersection, false otherwise

Definition at line 144 of file box.cc.

References IsInside(), xMax, xMin, yMax, yMin, zMax, and zMin.

Referenced by BoxLineIntersectionTestCase::DoRun(), and ns3::Building::IsIntersect().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ xMax

double ns3::Box::xMax

◆ xMin

double ns3::Box::xMin

The x coordinate of the left bound of the box.

Definition at line 110 of file box.h.

Referenced by FemtocellBlockAllocator::FemtocellBlockAllocator(), AreOverlapping(), BoxLineIntersectionTestCase::BuildNameString(), CalculateIntersection(), ns3::RandomWalk2dOutdoorMobilityModel::CalculateIntersectionFromOutside(), FemtocellBlockAllocator::Create(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FixedRoomPositionAllocator::GetNext(), ns3::Building::GetRoomX(), IsInside(), IsIntersect(), ns3::operator<<(), ns3::operator>>(), PrintGnuplottableBuildingListToFile(), and ns3::ConstantVelocityHelper::UpdateWithBounds().

◆ yMax

double ns3::Box::yMax

◆ yMin

double ns3::Box::yMin

The y coordinate of the bottom bound of the box.

Definition at line 114 of file box.h.

Referenced by FemtocellBlockAllocator::FemtocellBlockAllocator(), AreOverlapping(), BoxLineIntersectionTestCase::BuildNameString(), CalculateIntersection(), ns3::RandomWalk2dOutdoorMobilityModel::CalculateIntersectionFromOutside(), FemtocellBlockAllocator::Create(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FixedRoomPositionAllocator::GetNext(), ns3::Building::GetRoomY(), IsInside(), IsIntersect(), ns3::operator<<(), ns3::operator>>(), PrintGnuplottableBuildingListToFile(), and ns3::ConstantVelocityHelper::UpdateWithBounds().

◆ zMax

double ns3::Box::zMax

The z coordinate of the up bound of the box.

Definition at line 120 of file box.h.

Referenced by BoxLineIntersectionTestCase::BuildNameString(), BoxLineIntersectionTestCase::DoRun(), ns3::GaussMarkovMobilityModel::DoWalk(), GetClosestSide(), ns3::Building::GetFloor(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FixedRoomPositionAllocator::GetNext(), IsInside(), IsIntersect(), ns3::operator<<(), ns3::operator>>(), and ns3::ConstantVelocityHelper::UpdateWithBounds().

◆ zMin

double ns3::Box::zMin

The z coordinate of the down bound of the box.

Definition at line 118 of file box.h.

Referenced by BoxLineIntersectionTestCase::BuildNameString(), BoxLineIntersectionTestCase::DoRun(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::Building::GetFloor(), ns3::RandomRoomPositionAllocator::GetNext(), ns3::SameRoomPositionAllocator::GetNext(), ns3::FixedRoomPositionAllocator::GetNext(), IsInside(), IsIntersect(), ns3::operator<<(), ns3::operator>>(), and ns3::ConstantVelocityHelper::UpdateWithBounds().

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

src/mobility/model/box.h
src/mobility/model/box.cc

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ Side

Constructor & Destructor Documentation

◆ Box() [1/2]

◆ Box() [2/2]

Member Function Documentation

◆ CalculateIntersection()

◆ GetClosestSide()

◆ IsInside()

◆ IsIntersect()

Member Data Documentation

◆ xMax

◆ xMin

◆ yMax

◆ yMin

◆ zMax

◆ zMin