A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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"
24 #include "ipv4-interface-container.h"
25 
26 namespace ns3 {
27 
45 class Ipv4AddressHelper
46 {
47 public:
52  Ipv4AddressHelper ();
53 
59  Ipv4AddressHelper (Ipv4Address network, Ipv4Mask mask,
60  Ipv4Address base = "0.0.0.1");
61 
91  void SetBase (Ipv4Address network, Ipv4Mask mask,
92  Ipv4Address base = "0.0.0.1");
93 
120  Ipv4Address NewNetwork (void);
121 
146  Ipv4Address NewAddress (void);
147 
176  Ipv4InterfaceContainer Assign (const NetDeviceContainer &c);
177 
178 private:
185  uint32_t NumAddressBits (uint32_t maskbits) const;
186 
187  uint32_t m_network;
188  uint32_t m_mask;
189  uint32_t m_address;
190  uint32_t m_base;
191  uint32_t m_shift;
192  uint32_t m_max;
193 };
194 
195 } // namespace ns3
196 
197 #endif /* IPV4_ADDRESS_HELPER_H */
ns3::Ipv4AddressHelper::m_max
uint32_t m_max
maximum allowed address
Definition: ipv4-address-helper.h:192
ns3::Ipv4InterfaceContainer
holds a vector of std::pair of Ptr and interface index.
Definition: ipv4-interface-container.h:32
ns3::Ipv4Mask
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:222
ns3::Ipv4AddressHelper::m_mask
uint32_t m_mask
network mask
Definition: ipv4-address-helper.h:188
ns3::Ipv4AddressHelper::m_base
uint32_t m_base
base address
Definition: ipv4-address-helper.h:190
ns3::Ipv4AddressHelper::m_shift
uint32_t m_shift
shift, equivalent to the number of bits in the hostpart
Definition: ipv4-address-helper.h:191
ns3::Ipv4AddressHelper::NewAddress
Ipv4Address NewAddress(void)
Increment the IP address counter used to allocate IP addresses.
Definition: ipv4-address-helper.cc:98
ns3::Ipv4AddressHelper::Ipv4AddressHelper
Ipv4AddressHelper()
Construct a helper class to make life easier while doing simple IPv4 address assignment in scripts...
Definition: ipv4-address-helper.cc:33
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:41
ns3::Ipv4AddressHelper::m_network
uint32_t m_network
network address
Definition: ipv4-address-helper.h:187
ns3::Ipv4Address
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
ns3::Ipv4AddressHelper::Assign
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
Definition: ipv4-address-helper.cc:131
ns3::Ipv4AddressHelper::NewNetwork
Ipv4Address NewNetwork(void)
Increment the network number and reset the IP address counter to the base value provided in the SetBa...
Definition: ipv4-address-helper.cc:122
ns3::Ipv4AddressHelper
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Definition: ipv4-address-helper.h:45
ns3::Ipv4AddressHelper::SetBase
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Definition: ipv4-address-helper.cc:60
ns3::Ipv4AddressHelper::NumAddressBits
uint32_t NumAddressBits(uint32_t maskbits) const
Returns the number of address bits (hostpart) for a given netmask.
Definition: ipv4-address-helper.cc:167