A Discrete-Event Network Simulator
API
ipv4-address-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 University of Washington
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18 
19 #ifndef IPV4_ADDRESS_HELPER_H
20 #define IPV4_ADDRESS_HELPER_H
21 
22 #include "ns3/ipv4-address.h"
23 #include "ns3/net-device-container.h"
25 
26 namespace ns3 {
27 
48 {
49 public:
55 
64  Ipv4AddressHelper (Ipv4Address network, Ipv4Mask mask,
65  Ipv4Address base = "0.0.0.1");
66 
95  void SetBase (Ipv4Address network, Ipv4Mask mask,
96  Ipv4Address base = "0.0.0.1");
97 
124  Ipv4Address NewNetwork (void);
125 
150  Ipv4Address NewAddress (void);
151 
181 
182 private:
188  uint32_t NumAddressBits (uint32_t maskbits) const;
189 
190  uint32_t m_network;
191  uint32_t m_mask;
192  uint32_t m_address;
193  uint32_t m_base;
194  uint32_t m_shift;
195  uint32_t m_max;
196 };
197 
198 } // namespace ns3
199 
200 #endif /* IPV4_ADDRESS_HELPER_H */
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
uint32_t m_shift
shift, equivalent to the number of bits in the hostpart
uint32_t m_mask
network mask
Ipv4Address NewNetwork(void)
Increment the network number and reset the IP address counter to the base value provided in the SetBa...
uint32_t m_network
network address
uint32_t m_base
base address
Ipv4Address NewAddress(void)
Increment the IP address counter used to allocate IP addresses.
uint32_t m_max
maximum allowed address
Ipv4AddressHelper()
Construct a helper class to make life easier while doing simple IPv4 address assignment in scripts.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
uint32_t NumAddressBits(uint32_t maskbits) const
Returns the number of address bits (hostpart) for a given netmask.
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
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.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:256
holds a vector of ns3::NetDevice pointers
Every class exported by the ns3 library is enclosed in the ns3 namespace.