A Discrete-Event Network Simulator
API
ipv4-nix-vector-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 The Georgia Institute of Technology
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  * Authors: Josh Pelkey <jpelkey@gatech.edu>
19  */
20 
21 #ifndef IPV4_NIX_VECTOR_HELPER_H
22 #define IPV4_NIX_VECTOR_HELPER_H
23 
24 #include "ns3/object-factory.h"
25 #include "ns3/ipv4-routing-helper.h"
26 
27 namespace ns3 {
28 
38 class Ipv4NixVectorHelper : public Ipv4RoutingHelper
39 {
40 public:
45  Ipv4NixVectorHelper ();
46 
53  Ipv4NixVectorHelper (const Ipv4NixVectorHelper &o);
54 
61  Ipv4NixVectorHelper* Copy (void) const;
62 
69  virtual Ptr<Ipv4RoutingProtocol> Create (Ptr<Node> node) const;
70 
85  void PrintRoutingPathAt (Time printTime, Ptr<Node> source, Ipv4Address dest, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
86 
87 private:
93  Ipv4NixVectorHelper &operator = (const Ipv4NixVectorHelper &);
94 
95  ObjectFactory m_agentFactory;
96 
109  static void PrintRoute (Ptr<Node> source, Ipv4Address dest, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
110 };
111 } // namespace ns3
112 
113 #endif /* IPV4_NIX_VECTOR_HELPER_H */
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
ns3::Ipv4NixVectorHelper::PrintRoute
static void PrintRoute(Ptr< Node > source, Ipv4Address dest, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing path for the source and destination.
Definition: ipv4-nix-vector-helper.cc:58
ns3::Ipv4NixVectorHelper::m_agentFactory
ObjectFactory m_agentFactory
Object factory.
Definition: ipv4-nix-vector-helper.h:95
ns3::Ipv4NixVectorHelper
Helper class that adds Nix-vector routing to nodes.
Definition: ipv4-nix-vector-helper.h:38
ns3::Ipv4NixVectorHelper::operator=
Ipv4NixVectorHelper & operator=(const Ipv4NixVectorHelper &)
Assignment operator declared private and not implemented to disallow assignment and prevent the compi...
ns3::Ipv4NixVectorHelper::Ipv4NixVectorHelper
Ipv4NixVectorHelper()
Construct an Ipv4NixVectorHelper to make life easier while adding Nix-vector routing to nodes...
Definition: ipv4-nix-vector-helper.cc:26
ns3::Ipv4NixVectorHelper::Copy
Ipv4NixVectorHelper * Copy(void) const
Definition: ipv4-nix-vector-helper.cc:37
ns3::Ipv4NixVectorHelper::PrintRoutingPathAt
void PrintRoutingPathAt(Time printTime, Ptr< Node > source, Ipv4Address dest, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing path for a source and destination at a particular time.
Definition: ipv4-nix-vector-helper.cc:52
ns3::Time::Unit
Unit
The unit to use to interpret a number representing time.
Definition: nstime.h:109
ns3::Ipv4RoutingHelper
a factory to create ns3::Ipv4RoutingProtocol objects
Definition: ipv4-routing-helper.h:45
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::Ipv4NixVectorHelper::Create
virtual Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const
Definition: ipv4-nix-vector-helper.cc:43
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition: object-factory.h:47
ns3::Ipv4Address
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
ns3::Time::S
second
Definition: nstime.h:115