A Discrete-Event Network Simulator
API
ipv4-interface-container.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008 INRIA
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Mathieu Lacage <mathieu.lacage@cutebugs.net>
18  */
19 
20 #ifndef IPV4_INTERFACE_CONTAINER_H
21 #define IPV4_INTERFACE_CONTAINER_H
22 
23 #include "ns3/ipv4-address.h"
24 #include "ns3/ipv4.h"
25 
26 #include <stdint.h>
27 #include <vector>
28 
29 namespace ns3
30 {
31 
56 {
57  public:
61  typedef std::vector<std::pair<Ptr<Ipv4>, uint32_t>>::const_iterator Iterator;
62 
67 
72  void Add(const Ipv4InterfaceContainer& other);
73 
94  Iterator Begin() const;
95 
116  Iterator End() const;
117 
139  uint32_t GetN() const;
140 
151  Ipv4Address GetAddress(uint32_t i, uint32_t j = 0) const;
152 
158  void SetMetric(uint32_t i, uint16_t metric);
159 
167  void Add(Ptr<Ipv4> ipv4, uint32_t interface);
168 
176  void Add(std::pair<Ptr<Ipv4>, uint32_t> ipInterfacePair);
177 
186  void Add(std::string ipv4Name, uint32_t interface);
187 
209  std::pair<Ptr<Ipv4>, uint32_t> Get(uint32_t i) const;
210 
211  private:
215  typedef std::vector<std::pair<Ptr<Ipv4>, uint32_t>> InterfaceVector;
216 
221 };
222 
223 } // namespace ns3
224 
225 #endif /* IPV4_INTERFACE_CONTAINER_H */
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:43
holds a vector of std::pair of Ptr<Ipv4> and interface index.
std::vector< std::pair< Ptr< Ipv4 >, uint32_t > > InterfaceVector
Container for pairs of Ipv4 smart pointer / Interface Index.
Iterator End() const
Get an iterator which indicates past-the-last Node in the container.
std::pair< Ptr< Ipv4 >, uint32_t > Get(uint32_t i) const
Get the std::pair of an Ptr<Ipv4> and interface stored at the location specified by the index.
void SetMetric(uint32_t i, uint16_t metric)
Set a metric for the given interface.
std::vector< std::pair< Ptr< Ipv4 >, uint32_t > >::const_iterator Iterator
Container Const Iterator for pairs of Ipv4 smart pointer / Interface Index.
InterfaceVector m_interfaces
List of IPv4 stack and interfaces index.
void Add(const Ipv4InterfaceContainer &other)
Concatenate the entries in the other container with ours.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Iterator Begin() const
Get an iterator which refers to the first pair in the container.
Ipv4InterfaceContainer()
Create an empty Ipv4InterfaceContainer.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Every class exported by the ns3 library is enclosed in the ns3 namespace.