A Discrete-Event Network Simulator
API
config.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  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef CONFIG_H
21 #define CONFIG_H
22 
23 #include "ptr.h"
24 #include <string>
25 #include <vector>
26 
33 namespace ns3 {
34 
35 class AttributeValue;
36 class Object;
37 class CallbackBase;
38 
49 namespace Config {
50 
56 void Reset (void);
57 
67 void Set (std::string path, const AttributeValue &value);
77 void SetDefault (std::string name, const AttributeValue &value);
87 bool SetDefaultFailSafe (std::string name, const AttributeValue &value);
95 void SetGlobal (std::string name, const AttributeValue &value);
104 bool SetGlobalFailSafe (std::string name, const AttributeValue &value);
114 void ConnectWithoutContext (std::string path, const CallbackBase &cb);
122 void DisconnectWithoutContext (std::string path, const CallbackBase &cb);
133 void Connect (std::string path, const CallbackBase &cb);
141 void Disconnect (std::string path, const CallbackBase &cb);
142 
152 {
153 public:
155  typedef std::vector<Ptr<Object> >::const_iterator Iterator;
156  MatchContainer ();
164  MatchContainer (const std::vector<Ptr<Object> > &objects,
165  const std::vector<std::string> &contexts,
166  std::string path);
167 
171  MatchContainer::Iterator Begin (void) const;
175  MatchContainer::Iterator End (void) const;
179  std::size_t GetN (void) const;
184  Ptr<Object> Get (std::size_t i) const;
192  std::string GetMatchedPath (uint32_t i) const;
196  std::string GetPath (void) const;
197 
206  void Set (std::string name, const AttributeValue &value);
215  void Connect (std::string name, const CallbackBase &cb);
224  void ConnectWithoutContext (std::string name, const CallbackBase &cb);
233  void Disconnect (std::string name, const CallbackBase &cb);
242  void DisconnectWithoutContext (std::string name, const CallbackBase &cb);
243 
244 private:
246  std::vector<Ptr<Object> > m_objects;
248  std::vector<std::string> m_contexts;
250  std::string m_path;
251 };
252 
259 MatchContainer LookupMatches (std::string path);
260 
276 
281 std::size_t GetRootNamespaceObjectN (void);
282 
289 
290 } // namespace Config
291 
292 } // namespace ns3
293 
294 #endif /* CONFIG_H */
std::string GetMatchedPath(uint32_t i) const
Definition: config.cc:81
bool SetDefaultFailSafe(std::string fullName, const AttributeValue &value)
Definition: config.cc:820
void Set(std::string path, const AttributeValue &value)
Definition: config.cc:807
bool SetGlobalFailSafe(std::string name, const AttributeValue &value)
Definition: config.cc:857
void UnregisterRootNamespaceObject(Ptr< Object > obj)
Definition: config.cc:896
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:1194
void Disconnect(std::string name, const CallbackBase &cb)
Definition: config.cc:127
void DisconnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:867
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:890
void ConnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: config.cc:116
Ptr< Object > GetRootNamespaceObject(uint32_t i)
Definition: config.cc:908
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:862
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:873
MatchContainer::Iterator Begin(void) const
Definition: config.cc:57
std::string m_path
The path used to perform the object matching.
Definition: config.h:250
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::size_t GetRootNamespaceObjectN(void)
Definition: config.cc:902
hold a set of objects which match a specific search string.
Definition: config.h:151
std::vector< Ptr< Object > > m_objects
The list of objects in this container.
Definition: config.h:246
void Connect(std::string name, const CallbackBase &cb)
Definition: config.cc:104
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:787
MatchContainer LookupMatches(std::string path)
Definition: config.cc:884
void DisconnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: config.cc:139
void SetGlobal(std::string name, const AttributeValue &value)
Definition: config.cc:852
std::vector< std::string > m_contexts
The context for each object.
Definition: config.h:248
MatchContainer::Iterator End(void) const
Definition: config.cc:63
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:812
std::vector< Ptr< Object > >::const_iterator Iterator
Const iterator over the objects in this container.
Definition: config.h:155
void Set(std::string name, const AttributeValue &value)
Definition: config.cc:94
void Disconnect(std::string path, const CallbackBase &cb)
Definition: config.cc:879
std::string GetPath(void) const
Definition: config.cc:87