A Discrete-Event Network Simulator
API
point-to-point-star.h
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation;
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  */
15 
16 // Define an object to create a star topology.
17 
18 #ifndef POINT_TO_POINT_STAR_HELPER_H
19 #define POINT_TO_POINT_STAR_HELPER_H
20 
21 #include "ns3/internet-stack-helper.h"
22 #include "ns3/ipv4-address-helper.h"
23 #include "ns3/ipv4-interface-container.h"
24 #include "ns3/ipv6-address-helper.h"
25 #include "ns3/ipv6-interface-container.h"
26 #include "ns3/point-to-point-helper.h"
27 
28 #include <string>
29 
30 namespace ns3
31 {
32 
45 {
46  public:
58  PointToPointStarHelper(uint32_t numSpokes, PointToPointHelper p2pHelper);
59 
61 
62  public:
67  Ptr<Node> GetHub() const;
68 
74  Ptr<Node> GetSpokeNode(uint32_t i) const;
75 
81  Ipv4Address GetHubIpv4Address(uint32_t i) const;
82 
88  Ipv4Address GetSpokeIpv4Address(uint32_t i) const;
89 
95  Ipv6Address GetHubIpv6Address(uint32_t i) const;
96 
102  Ipv6Address GetSpokeIpv6Address(uint32_t i) const;
103 
107  uint32_t SpokeCount() const;
108 
114 
121 
127  void AssignIpv6Addresses(Ipv6Address network, Ipv6Prefix prefix);
128 
138  void BoundingBox(double ulx, double uly, double lrx, double lry);
139 
140  private:
149 };
150 
151 } // namespace ns3
152 
153 #endif /* POINT_TO_POINT_STAR_HELPER_H */
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Describes an IPv6 address.
Definition: ipv6-address.h:49
Keep track of a set of IPv6 interfaces.
Describes an IPv6 prefix.
Definition: ipv6-address.h:455
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Build a set of PointToPointNetDevice objects.
A helper to make it easier to create a star topology with PointToPoint links.
Ptr< Node > GetSpokeNode(uint32_t i) const
NodeContainer m_hub
Hub node.
Ipv6InterfaceContainer m_hubInterfaces6
IPv6 hub interfaces.
void InstallStack(InternetStackHelper stack)
Ipv4Address GetSpokeIpv4Address(uint32_t i) const
NodeContainer m_spokes
Spoke nodes.
NetDeviceContainer m_hubDevices
Hub node NetDevices.
Ipv4InterfaceContainer m_spokeInterfaces
IPv4 spoke nodes interfaces.
PointToPointStarHelper(uint32_t numSpokes, PointToPointHelper p2pHelper)
Create a PointToPointStarHelper in order to easily create star topologies using p2p links.
Ipv4InterfaceContainer m_hubInterfaces
IPv4 hub interfaces.
Ipv4Address GetHubIpv4Address(uint32_t i) const
void AssignIpv6Addresses(Ipv6Address network, Ipv6Prefix prefix)
Ipv6Address GetSpokeIpv6Address(uint32_t i) const
void BoundingBox(double ulx, double uly, double lrx, double lry)
Sets up the node canvas locations for every node in the star.
void AssignIpv4Addresses(Ipv4AddressHelper address)
Ipv6Address GetHubIpv6Address(uint32_t i) const
Ipv6InterfaceContainer m_spokeInterfaces6
IPv6 spoke nodes interfaces.
NetDeviceContainer m_spokeDevices
Spoke nodes NetDevices.
address
Definition: first.py:47
stack
Definition: first.py:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.