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