A Discrete-Event Network Simulator
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
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef CONFIG_H
21 #define CONFIG_H
23 #include "ptr.h"
24 #include <string>
25 #include <vector>
33 namespace ns3 {
35 class AttributeValue;
36 class Object;
37 class CallbackBase;
49 namespace Config {
56 void Reset (void);
68 void Set (std::string path, const AttributeValue &value);
75 bool SetFailSafe (std::string path, const AttributeValue &value);
85 void SetDefault (std::string name, const AttributeValue &value);
95 bool SetDefaultFailSafe (std::string name, const AttributeValue &value);
103 void SetGlobal (std::string name, const AttributeValue &value);
112 bool SetGlobalFailSafe (std::string name, const AttributeValue &value);
124 void ConnectWithoutContext (std::string path, const CallbackBase &cb);
132 bool ConnectWithoutContextFailSafe (std::string path, const CallbackBase &cb);
140 void DisconnectWithoutContext (std::string path, const CallbackBase &cb);
154 void Connect (std::string path, const CallbackBase &cb);
162 bool ConnectFailSafe (std::string path, const CallbackBase &cb);
170 void Disconnect (std::string path, const CallbackBase &cb);
181 {
182 public:
184  typedef std::vector<Ptr<Object> >::const_iterator Iterator;
185  MatchContainer ();
193  MatchContainer (const std::vector<Ptr<Object> > &objects,
194  const std::vector<std::string> &contexts,
195  std::string path);
200  MatchContainer::Iterator Begin (void) const;
204  MatchContainer::Iterator End (void) const;
208  std::size_t GetN (void) const;
213  Ptr<Object> Get (std::size_t i) const;
221  std::string GetMatchedPath (uint32_t i) const;
225  std::string GetPath (void) const;
237  void Set (std::string name, const AttributeValue &value);
244  bool SetFailSafe (std::string name, const AttributeValue &value);
255  void Connect (std::string name, const CallbackBase &cb);
262  bool ConnectFailSafe (std::string name, const CallbackBase &cb);
273  void ConnectWithoutContext (std::string name, const CallbackBase &cb);
280  bool ConnectWithoutContextFailSafe (std::string name, const CallbackBase &cb);
289  void Disconnect (std::string name, const CallbackBase &cb);
298  void DisconnectWithoutContext (std::string name, const CallbackBase &cb);
300 private:
302  std::vector<Ptr<Object> > m_objects;
304  std::vector<std::string> m_contexts;
306  std::string m_path;
307 };
315 MatchContainer LookupMatches (std::string path);
337 std::size_t GetRootNamespaceObjectN (void);
346 } // namespace Config
348 } // namespace ns3
350 #endif /* CONFIG_H */
std::string GetMatchedPath(uint32_t i) const
Definition: config.cc:81
bool ConnectWithoutContextFailSafe(std::string name, const CallbackBase &cb)
Connect the specified sink to all the objects stored in this container.
Definition: config.cc:147
bool SetDefaultFailSafe(std::string fullName, const AttributeValue &value)
Definition: config.cc:857
bool SetFailSafe(std::string path, const AttributeValue &value)
This function will attempt to find attributes which match the input path and will then set their valu...
Definition: config.cc:844
void Set(std::string path, const AttributeValue &value)
Definition: config.cc:839
bool SetGlobalFailSafe(std::string name, const AttributeValue &value)
Definition: config.cc:894
void UnregisterRootNamespaceObject(Ptr< Object > obj)
Definition: config.cc:950
ns3::Ptr smart pointer declaration and implementation.
Hold a value for an Attribute.
Definition: attribute.h:68
Base class for Callback class.
Definition: callback.h:1195
void Disconnect(std::string name, const CallbackBase &cb)
Definition: config.cc:159
void DisconnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:912
Ptr< Object > Get(std::size_t i) const
Definition: config.cc:75
std::size_t GetN(void) const
Definition: config.cc:69
void RegisterRootNamespaceObject(Ptr< Object > obj)
Definition: config.cc:944
bool ConnectFailSafe(std::string name, const CallbackBase &cb)
Connect the specified sink to all the objects stored in this container.
Definition: config.cc:125
void ConnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: config.cc:139
Ptr< Object > GetRootNamespaceObject(uint32_t i)
Definition: config.cc:962
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:899
bool SetFailSafe(std::string name, const AttributeValue &value)
Set the specified attribute value to all the objects stored in this container.
Definition: config.cc:105
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:918
MatchContainer::Iterator Begin(void) const
Definition: config.cc:57
bool ConnectWithoutContextFailSafe(std::string path, const CallbackBase &cb)
This function will attempt to find all trace sources which match the input path and will then connect...
Definition: config.cc:907
std::string m_path
The path used to perform the object matching.
Definition: config.h:306
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::size_t GetRootNamespaceObjectN(void)
Definition: config.cc:956
bool ConnectFailSafe(std::string path, const CallbackBase &cb)
This function will attempt to find all trace sources which match the input path and will then connect...
Definition: config.cc:927
hold a set of objects which match a specific search string.
Definition: config.h:180
std::vector< Ptr< Object > > m_objects
The list of objects in this container.
Definition: config.h:302
void Connect(std::string name, const CallbackBase &cb)
Definition: config.cc:117
void Reset(void)
Reset the initial value of every attribute as well as the value of every global to what they were bef...
Definition: config.cc:820
MatchContainer LookupMatches(std::string path)
Definition: config.cc:938
void DisconnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: config.cc:171
void SetGlobal(std::string name, const AttributeValue &value)
Definition: config.cc:889
std::vector< std::string > m_contexts
The context for each object.
Definition: config.h:304
MatchContainer::Iterator End(void) const
Definition: config.cc:63
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:849
std::vector< Ptr< Object > >::const_iterator Iterator
Const iterator over the objects in this container.
Definition: config.h:184
void Set(std::string name, const AttributeValue &value)
Definition: config.cc:94
void Disconnect(std::string path, const CallbackBase &cb)
Definition: config.cc:933
std::string GetPath(void) const
Definition: config.cc:87