ns-3-leo/helper/leo-orbit-node-helper.h
2020-09-03 21:20:13 +02:00

81 lines
2.1 KiB
C++

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* 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: Tim Schubert <ns-3-leo@timschubert.net>
*/
#ifndef LEO_ORBIT_NODE_HELPER_H
#define LEO_ORBIT_NODE_HELPER_H
#include <string>
#include "ns3/object-factory.h"
#include "ns3/node-container.h"
#include "ns3/leo-circular-orbit-mobility-model.h"
#include "ns3/leo-circular-orbit-position-allocator.h"
#include "ns3/leo-orbit.h"
/**
* \brief Builds a node container of nodes with LEO positions using a list of
* orbit definitions.
*
* Adds orbits with from a file for each node.
*/
namespace ns3
{
class LeoOrbitNodeHelper
{
public:
LeoOrbitNodeHelper ();
virtual ~LeoOrbitNodeHelper ();
/**
*
* \param orbitFile path to orbit definitions file
* \returns a node container containing nodes using the specified attributes
*/
NodeContainer Install (const std::string &orbitFile);
/**
*
* \param orbits orbit definitions
* \returns a node container containing nodes using the specified attributes
*/
NodeContainer Install (const std::vector<LeoOrbit> &orbits);
/**
*
* \param orbit orbit definition
* \returns a node container containing nodes using the specified attributes
*/
NodeContainer Install (const LeoOrbit &orbit);
/**
* 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:
ObjectFactory m_nodeFactory;
};
}; // namespace ns3
#endif