A Discrete-Event Network Simulator
API
csma-star-helper.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 CSMA_STAR_HELPER_H
20 #define CSMA_STAR_HELPER_H
21 
22 #include <string>
23 
24 #include "ns3/csma-helper.h"
25 #include "ns3/ipv4-address-helper.h"
26 #include "ns3/ipv6-address-helper.h"
27 #include "ns3/internet-stack-helper.h"
28 #include "ns3/ipv4-interface-container.h"
29 #include "ns3/ipv6-interface-container.h"
30 #include "ns3/ipv6-address-generator.h"
31 
32 namespace ns3 {
33 
46 {
47 public:
59  CsmaStarHelper (uint32_t numSpokes,
60  CsmaHelper csmaHelper);
61 
62  ~CsmaStarHelper ();
63 
64 public:
69  Ptr<Node> GetHub () const;
70 
76  Ptr<Node> GetSpokeNode (uint32_t i) const;
77 
83 
89 
95  Ipv4Address GetHubIpv4Address (uint32_t i) const;
96 
102  Ipv6Address GetHubIpv6Address (uint32_t i) const;
103 
109  Ipv4Address GetSpokeIpv4Address (uint32_t i) const;
110 
116  Ipv6Address GetSpokeIpv6Address (uint32_t i) const;
117 
121  uint32_t SpokeCount () const;
122 
128 
135 
141  void AssignIpv6Addresses (Ipv6Address network, Ipv6Prefix prefix);
142 
143 private:
152 };
153 
154 } // namespace ns3
155 
156 #endif /* CSMA_STAR_HELPER_H */
build a set of CsmaNetDevice objects
Definition: csma-helper.h:47
A helper to make it easier to create a star topology with Csma links.
void AssignIpv6Addresses(Ipv6Address network, Ipv6Prefix prefix)
void InstallStack(InternetStackHelper stack)
Ipv6InterfaceContainer m_spokeInterfaces6
Ipv6InterfaceContainer for the spokes IPv6 interfaces.
NetDeviceContainer m_spokeDevices
NetDeviceContainer for the spokes nodes NetDevices.
Ipv4Address GetSpokeIpv4Address(uint32_t i) const
NodeContainer m_spokes
NodeContainer for the spokes nodes.
Ipv4Address GetHubIpv4Address(uint32_t i) const
CsmaStarHelper(uint32_t numSpokes, CsmaHelper csmaHelper)
Create a CsmaStarHelper in order to easily create star topologies using Csma links.
Ipv6Address GetHubIpv6Address(uint32_t i) const
void AssignIpv4Addresses(Ipv4AddressHelper address)
Ptr< Node > GetSpokeNode(uint32_t i) const
Ptr< Node > GetHub() const
Ipv6InterfaceContainer m_hubInterfaces6
Ipv6InterfaceContainer for the hub IPv6 interfaces.
NetDeviceContainer m_hubDevices
NetDeviceContainer for the hub node NetDevices.
Ipv4InterfaceContainer m_hubInterfaces
Ipv4InterfaceContainer for the hub IPv4 interfaces.
NetDeviceContainer GetSpokeDevices() const
uint32_t SpokeCount() const
Ipv4InterfaceContainer m_spokeInterfaces
Ipv4InterfaceContainer for the spokes IPv4 interfaces.
NodeContainer m_hub
NodeContainer for the hub node.
NetDeviceContainer GetHubDevices() const
Ipv6Address GetSpokeIpv6Address(uint32_t i) const
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:41
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Describes an IPv6 address.
Definition: ipv6-address.h:50
Keep track of a set of IPv6 interfaces.
Describes an IPv6 prefix.
Definition: ipv6-address.h:456
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
address
Definition: first.py:44
stack
Definition: first.py:41
Every class exported by the ns3 library is enclosed in the ns3 namespace.