A Discrete-Event Network Simulator
API
config-store.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 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@cutebugs.net>
19  */
20 
21 #ifndef CONFIG_STORE_H
22 #define CONFIG_STORE_H
23 
24 #include "ns3/object-base.h"
25 #include "file-config.h"
26 
27 namespace ns3 {
28 
59 class ConfigStore : public ObjectBase
60 {
61 public:
66  enum Mode {
69  NONE
70  };
75  enum FileFormat {
77  XML,
78  RAW_TEXT
79  };
80 
85  static TypeId GetTypeId (void);
86  virtual TypeId GetInstanceTypeId (void) const;
87 
88  ConfigStore ();
89  ~ConfigStore ();
90 
95  void SetMode (enum Mode mode);
100  void SetFileFormat (enum FileFormat format);
105  void SetFilename (std::string filename);
110  void SetSaveDeprecated (bool saveDeprecated);
111 
115  void ConfigureDefaults (void);
119  void ConfigureAttributes (void);
120 
121 private:
122  enum Mode m_mode;
123  enum FileFormat m_fileFormat;
125  std::string m_filename;
127 };
128 
136 std::ostream & operator << (std::ostream & os, ConfigStore::Mode & mode);
144 std::ostream & operator << (std::ostream & os, ConfigStore::FileFormat & format);
145 
146 } // namespace ns3
147 
148 #endif /* CONFIG_STORE_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
file-config.h
ns3::ConfigStore::m_filename
std::string m_filename
store file name
Definition: config-store.h:125
ns3::ConfigStore::GetInstanceTypeId
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: config-store.cc:81
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::ConfigStore::SetSaveDeprecated
void SetSaveDeprecated(bool saveDeprecated)
Set if to save deprecated attributes.
Definition: config-store.cc:171
ns3::ConfigStore::m_mode
enum Mode m_mode
store mode
Definition: config-store.h:122
ns3::ConfigStore::m_fileFormat
enum FileFormat m_fileFormat
store format
Definition: config-store.h:123
ns3::ConfigStore::SetMode
void SetMode(enum Mode mode)
Set the mode of operation.
Definition: config-store.cc:153
ns3::ConfigStore::ConfigStore
ConfigStore()
Definition: config-store.cc:87
ns3::ConfigStore::Mode
Mode
for ConfigStore operation
Definition: config-store.h:66
ns3::ConfigStore::m_file
FileConfig * m_file
configuration file
Definition: config-store.h:126
ns3::ConfigStore::NONE
@ NONE
Definition: config-store.h:69
ns3::ConfigStore::~ConfigStore
~ConfigStore()
Definition: config-store.cc:145
ns3::ConfigStore::FileFormat
FileFormat
store format
Definition: config-store.h:76
ns3::ConfigStore::m_saveDeprecated
bool m_saveDeprecated
save deprecated attributes
Definition: config-store.h:124
ns3::ConfigStore
Introspection did not find any typical Config paths.
Definition: config-store.h:60
ns3::ConfigStore::ConfigureDefaults
void ConfigureDefaults(void)
Configure the default values.
Definition: config-store.cc:185
ns3::ConfigStore::XML
@ XML
Definition: config-store.h:77
ns3::ConfigStore::SAVE
@ SAVE
Definition: config-store.h:68
ns3::ConfigStore::SetFilename
void SetFilename(std::string filename)
Set the filename.
Definition: config-store.cc:165
ns3::ConfigStore::SetFileFormat
void SetFileFormat(enum FileFormat format)
Set the file format.
Definition: config-store.cc:159
ns3::ConfigStore::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: config-store.cc:49
ns3::ConfigStore::RAW_TEXT
@ RAW_TEXT
Definition: config-store.h:78
ns3::FileConfig
base class for ConfigStore classes using files
Definition: file-config.h:34
ns3::ConfigStore::LOAD
@ LOAD
Definition: config-store.h:67
ns3::ConfigStore::ConfigureAttributes
void ConfigureAttributes(void)
Configure the attribute values.
Definition: config-store.cc:178
ns3::operator<<
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition: angles.cc:137
ns3::ObjectBase
Anchor the ns-3 type and attribute system.
Definition: object-base.h:120