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 18:13:57 +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

22
helper/satellite-node-helper.h
View file

@ -27,38 +27,46 @@
#include "ns3/leo-input-fstream-container.h"
/**
* \brief Builds a node container with a waypoint mobility model
*
* Adds waypoints from file for each node.
* The node satId must must correspond to the NORAD id from Celestrack.
* \file
* \ingroup leo
*/
namespace ns3
{
/**
* \ingroup leo
* \brief Builds a node container with a waypoint mobility model
*
* Adds waypoints from file for each node.
* The node satId must must correspond to the NORAD id from Celestrack.
*/
class LeoSatNodeHelper
{
public:
/// constructor
LeoSatNodeHelper ();
/// destructor
virtual ~LeoSatNodeHelper ();
/**
*
* \brief Install the nodes
* \param nodeIds paths to satellite to waypoint files
* \returns a node container containing nodes using the specified attributes
*/
NodeContainer Install (std::vector<std::string> &wpFiles);
/**
* 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:
/// Satellite nodes
ObjectFactory m_satNodeFactory;
/// Stream of waypoints
LeoWaypointInputFileStreamContainer m_fileStreamContainer;
};