A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
box.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2009 Dan Broyles
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Author: Dan Broyles <dbroyl01@ku.edu>
18
*/
19
#ifndef BOX_H
20
#define BOX_H
21
22
#include "ns3/attribute-helper.h"
23
#include "ns3/attribute.h"
24
#include "ns3/vector.h"
25
26
namespace
ns3
27
{
28
29
/**
30
* \ingroup mobility
31
* \brief a 3d box
32
* \see attribute_Box
33
*/
34
class
Box
35
{
36
public
:
37
/**
38
* Enum class to specify sides of a box
39
*/
40
enum
Side
41
{
42
RIGHT
,
43
LEFT
,
44
TOP
,
45
BOTTOM
,
46
UP
,
47
DOWN
48
};
49
50
/**
51
* \param _xMin x coordinates of left boundary.
52
* \param _xMax x coordinates of right boundary.
53
* \param _yMin y coordinates of bottom boundary.
54
* \param _yMax y coordinates of top boundary.
55
* \param _zMin z coordinates of down boundary.
56
* \param _zMax z coordinates of up boundary.
57
*
58
* Create a box.
59
*/
60
Box
(
double
_xMin,
double
_xMax,
double
_yMin,
double
_yMax,
double
_zMin,
double
_zMax);
61
/**
62
* Create a zero-sized box located at coordinates (0.0,0.0,0.0)
63
*/
64
Box
();
65
/**
66
* \param position the position to test.
67
* \returns true if the input position is located within the box,
68
* false otherwise.
69
*
70
* This method compares the x, y, and z coordinates of the input position.
71
*/
72
bool
IsInside
(
const
Vector& position)
const
;
73
/**
74
* \param position the position to test.
75
* \returns the side of the cube the input position is closest to.
76
*
77
* This method compares the x, y, and z coordinates of the input position.
78
*/
79
Side
GetClosestSide
(
const
Vector& position)
const
;
80
/**
81
* \param current the current position
82
* \param speed the current speed
83
* \returns the intersection point between the rectangle and the current+speed vector.
84
*
85
* This method assumes that the current position is located _inside_
86
* the cube and checks for this with an assert.
87
* This method compares only the x and y coordinates of the input position
88
* and speed. It ignores the z coordinate.
89
*/
90
Vector
CalculateIntersection
(
const
Vector& current,
const
Vector& speed)
const
;
91
/**
92
* \brief Checks if a line-segment between position l1 and position l2
93
* intersects a box.
94
*
95
* This method considers all the three coordinates, i.e., x, y, and z.
96
* This function was developed by NYU Wireless and is based on the algorithm
97
* described here http://www.3dkingdoms.com/weekly/weekly.php?a=21.
98
* Reference: Menglei Zhang, Michele Polese, Marco Mezzavilla, Sundeep Rangan,
99
* Michele Zorzi. "ns-3 Implementation of the 3GPP MIMO Channel Model for
100
* Frequency Spectrum above 6 GHz". In Proceedings of the Workshop on ns-3
101
* (WNS3 '17). 2017.
102
*
103
* \param l1 position
104
* \param l2 position
105
* \return true if there is a intersection, false otherwise
106
*/
107
bool
IsIntersect
(
const
Vector& l1,
const
Vector& l2)
const
;
108
109
/** The x coordinate of the left bound of the box */
110
double
xMin
;
111
/** The x coordinate of the right bound of the box */
112
double
xMax
;
113
/** The y coordinate of the bottom bound of the box */
114
double
yMin
;
115
/** The y coordinate of the top bound of the box */
116
double
yMax
;
117
/** The z coordinate of the down bound of the box */
118
double
zMin
;
119
/** The z coordinate of the up bound of the box */
120
double
zMax
;
121
};
122
123
std::ostream&
operator<<
(std::ostream& os,
const
Box
& box);
124
std::istream&
operator>>
(std::istream& is,
Box
& box);
125
126
ATTRIBUTE_HELPER_HEADER
(
Box
);
127
128
}
// namespace ns3
129
130
#endif
/* BOX_H */
ns3::Box
a 3d box
Definition:
box.h:35
ns3::Box::yMax
double yMax
The y coordinate of the top bound of the box.
Definition:
box.h:116
ns3::Box::IsInside
bool IsInside(const Vector &position) const
Definition:
box.cc:54
ns3::Box::xMin
double xMin
The x coordinate of the left bound of the box.
Definition:
box.h:110
ns3::Box::Side
Side
Enum class to specify sides of a box.
Definition:
box.h:41
ns3::Box::RIGHT
@ RIGHT
Definition:
box.h:42
ns3::Box::UP
@ UP
Definition:
box.h:46
ns3::Box::DOWN
@ DOWN
Definition:
box.h:47
ns3::Box::BOTTOM
@ BOTTOM
Definition:
box.h:45
ns3::Box::LEFT
@ LEFT
Definition:
box.h:43
ns3::Box::TOP
@ TOP
Definition:
box.h:44
ns3::Box::yMin
double yMin
The y coordinate of the bottom bound of the box.
Definition:
box.h:114
ns3::Box::xMax
double xMax
The x coordinate of the right bound of the box.
Definition:
box.h:112
ns3::Box::CalculateIntersection
Vector CalculateIntersection(const Vector ¤t, const Vector &speed) const
Definition:
box.cc:108
ns3::Box::zMin
double zMin
The z coordinate of the down bound of the box.
Definition:
box.h:118
ns3::Box::IsIntersect
bool IsIntersect(const Vector &l1, const Vector &l2) const
Checks if a line-segment between position l1 and position l2 intersects a box.
Definition:
box.cc:144
ns3::Box::GetClosestSide
Side GetClosestSide(const Vector &position) const
Definition:
box.cc:61
ns3::Box::Box
Box()
Create a zero-sized box located at coordinates (0.0,0.0,0.0)
Definition:
box.cc:43
ns3::Box::zMax
double zMax
The z coordinate of the up bound of the box.
Definition:
box.h:120
ATTRIBUTE_HELPER_HEADER
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type
Definition:
attribute-helper.h:407
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::operator<<
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition:
angles.cc:159
ns3::operator>>
std::istream & operator>>(std::istream &is, Angles &a)
Definition:
angles.cc:183
src
mobility
model
box.h
Generated on Tue May 28 2024 23:38:15 for ns-3 by
1.9.6