/usr/include/ns3.17/ns3/box.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 Dan Broyles
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Dan Broyles <dbroyl01@ku.edu>
*/
#ifndef BOX_H
#define BOX_H
#include "ns3/attribute.h"
#include "ns3/attribute-helper.h"
#include "ns3/vector.h"
namespace ns3 {
/**
* \ingroup mobility
* \brief a 3d box
*/
class Box
{
public:
enum Side {
RIGHT,
LEFT,
TOP,
BOTTOM,
UP,
DOWN
};
/**
* \param _xMin x coordinates of left boundary.
* \param _xMax x coordinates of right boundary.
* \param _yMin y coordinates of bottom boundary.
* \param _yMax y coordinates of top boundary.
* \param _zMin z coordinates of down boundary.
* \param _zMax z coordinates of up boundary.
*
* Create a box.
*/
Box (double _xMin, double _xMax,
double _yMin, double _yMax,
double _zMin, double _zMax);
/**
* Create a zero-sized box located at coordinates (0.0,0.0,0.0)
*/
Box ();
/**
* \param 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.
*/
bool IsInside (const Vector &position) const;
/**
* \param 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.
*/
Side GetClosestSide (const Vector &position) const;
/**
* \param current the current position
* \param 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.
*/
Vector CalculateIntersection (const Vector ¤t, const Vector &speed) const;
/* The x coordinate of the left bound of the box */
double xMin;
/* The x coordinate of the right bound of the box */
double xMax;
/* The y coordinate of the bottom bound of the box */
double yMin;
/* The y coordinate of the top bound of the box */
double yMax;
/* The z coordinate of the down bound of the box */
double zMin;
/* The z coordinate of the up bound of the box */
double zMax;
};
std::ostream &operator << (std::ostream &os, const Box &box);
std::istream &operator >> (std::istream &is, Box &box);
/**
* \class ns3::BoxValue
* \brief hold objects of type ns3::Box
*/
ATTRIBUTE_HELPER_HEADER (Box);
} // namespace ns3
#endif /* BOX_H */
|