A Discrete-Event Network Simulator
API
olsr-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 INRIA
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  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef OLSR_HELPER_H
21 #define OLSR_HELPER_H
22 
23 #include "ns3/object-factory.h"
24 #include "ns3/node.h"
25 #include "ns3/node-container.h"
26 #include "ns3/ipv4-routing-helper.h"
27 #include <map>
28 #include <set>
29 
30 namespace ns3 {
31 
41 {
42 public:
47  OlsrHelper ();
48 
55  OlsrHelper (const OlsrHelper &o);
56 
63  OlsrHelper* Copy (void) const;
64 
71  void ExcludeInterface (Ptr<Node> node, uint32_t interface);
72 
79  virtual Ptr<Ipv4RoutingProtocol> Create (Ptr<Node> node) const;
80 
87  void Set (std::string name, const AttributeValue &value);
88 
100  int64_t AssignStreams (NodeContainer c, int64_t stream);
101 
102 private:
110 
111  std::map< Ptr<Node>, std::set<uint32_t> > m_interfaceExclusions;
112 };
113 
114 } // namespace ns3
115 
116 #endif /* OLSR_HELPER_H */
Hold a value for an Attribute.
Definition: attribute.h:69
a factory to create ns3::Ipv4RoutingProtocol objects
keep track of a set of node pointers.
Instantiate subclasses of ns3::Object.
Helper class that adds OLSR routing to nodes.
Definition: olsr-helper.h:41
virtual Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const
Definition: olsr-helper.cc:65
OlsrHelper & operator=(const OlsrHelper &)
Assignment operator declared private and not implemented to disallow assignment and prevent the compi...
void Set(std::string name, const AttributeValue &value)
Definition: olsr-helper.cc:81
void ExcludeInterface(Ptr< Node > node, uint32_t interface)
Definition: olsr-helper.cc:47
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Definition: olsr-helper.cc:87
OlsrHelper()
Create an OlsrHelper that makes life easier for people who want to install OLSR routing to nodes.
Definition: olsr-helper.cc:29
OlsrHelper * Copy(void) const
Definition: olsr-helper.cc:41
ObjectFactory m_agentFactory
Object factory.
Definition: olsr-helper.h:109
std::map< Ptr< Node >, std::set< uint32_t > > m_interfaceExclusions
container of interfaces excluded from OLSR operations
Definition: olsr-helper.h:111
Every class exported by the ns3 library is enclosed in the ns3 namespace.