dadada/ns-3-leo
dadada/ns-3-leo
1
0
Fork 0
mirror of https://gitlab.ibr.cs.tu-bs.de/tschuber/ns-3-leo.git synced 2025-06-08 10:03:58 +02:00
Code Issues Releases Wiki Activity

Update doxygen documentation

Browse source
This commit is contained in:
Tim Schubert 2020-09-06 21:37:47 +02:00
parent 61b6fd7ea1
commit f17ff6abc6
38 changed files with 1023 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

23
helper/ground-node-helper.h
View file

@ -29,29 +29,35 @@
#define LEO_GND_RAD_EARTH 6.371e6
/**
* \brief Builds a node container of nodes with constant positions
*
* Adds waypoints from file for each node.
* \file
* \ingroup leo
*/
namespace ns3
{
/**
* \ingroup leo
* \brief Builds a node container of nodes with constant positions
* Adds waypoints from file for each node.
*/
class LeoGndNodeHelper
{
public:
/// constructor
LeoGndNodeHelper ();
/// deconstructor
virtual ~LeoGndNodeHelper ();
/**
*
* \brief Create a node container with nodes at the positions in file
* \param file path to latitude longitude file
* \returns a node container containing nodes using the specified attributes
*/
NodeContainer Install (const std::string &file);
/**
*
* \brief Create a node container with uniformly distributed nodes
* \param latNodes a number of nodes to in latitude direction
* \param lonNodes a number of nodes to in longitude direction
* \returns a node container containing nodes using the specified attributes
@ -59,7 +65,7 @@ public:
NodeContainer Install (uint32_t latNodes, uint32_t lonNodes);
/**
*
* \brief Install two nodes at two locations
* \param location1 first location
* \param location2 second location
* \returns a node container containing nodes using the specified attributes
@ -68,16 +74,17 @@ public:
const LeoLatLong &location2);
/**
* Set an attribute for each node
*
* \brief Set an attribute for each node
* \param name name of the attribute
* \param value value of the attribute
*/
void SetAttribute (std::string name, const AttributeValue &value);
private:
/// Fatory for nodes
ObjectFactory m_gndNodeFactory;
/// Convert the latitude and longitude to a position on a sphere
static Vector3D GetEarthPosition (const LeoLatLong &loc);
};