A Discrete-Event Network Simulator
API
enum.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 ENUM_VALUE_H
21 #define ENUM_VALUE_H
22 
23 #include "attribute.h"
25 #include <list>
26 
33 namespace ns3 {
34 
35 // Additional docs for class EnumValue:
54 class EnumValue : public AttributeValue
55 {
56 public:
57  EnumValue ();
63  EnumValue (int value);
64  void Set (int value);
65  int Get (void) const;
66  template <typename T>
67  bool GetAccessor (T & value) const;
68 
69  virtual Ptr<AttributeValue> Copy (void) const;
70  virtual std::string SerializeToString (Ptr<const AttributeChecker> checker) const;
71  virtual bool DeserializeFromString (std::string value, Ptr<const AttributeChecker> checker);
72 
73 private:
74  int m_value;
75 };
76 
77 template <typename T>
78 bool
79 EnumValue::GetAccessor (T &value) const
80 {
81  value = T (m_value);
82  return true;
83 }
84 
86 {
87 public:
88  EnumChecker ();
89 
95  void AddDefault (int value, std::string name);
101  void Add (int value, std::string name);
102 
103  virtual bool Check (const AttributeValue &value) const;
104  virtual std::string GetValueTypeName (void) const;
105  virtual bool HasUnderlyingTypeInformation (void) const;
106  virtual std::string GetUnderlyingTypeInformation (void) const;
107  virtual Ptr<AttributeValue> Create (void) const;
108  virtual bool Copy (const AttributeValue &src, AttributeValue &dst) const;
109 
110 private:
111  friend class EnumValue;
113  typedef std::list<std::pair<int,std::string> > ValueSet;
115  ValueSet m_valueSet;
116 };
117 
118 template <typename T1>
120 
121 template <typename T1, typename T2>
123 
180 Ptr<const AttributeChecker> MakeEnumChecker (int v1, std::string n1,
181  int v2 = 0, std::string n2 = "",
182  int v3 = 0, std::string n3 = "",
183  int v4 = 0, std::string n4 = "",
184  int v5 = 0, std::string n5 = "",
185  int v6 = 0, std::string n6 = "",
186  int v7 = 0, std::string n7 = "",
187  int v8 = 0, std::string n8 = "",
188  int v9 = 0, std::string n9 = "",
189  int v10 = 0, std::string n10 = "",
190  int v11 = 0, std::string n11 = "",
191  int v12 = 0, std::string n12 = "",
192  int v13 = 0, std::string n13 = "",
193  int v14 = 0, std::string n14 = "",
194  int v15 = 0, std::string n15 = "",
195  int v16 = 0, std::string n16 = "",
196  int v17 = 0, std::string n17 = "",
197  int v18 = 0, std::string n18 = "",
198  int v19 = 0, std::string n19 = "",
199  int v20 = 0, std::string n20 = "",
200  int v21 = 0, std::string n21 = "",
201  int v22 = 0, std::string n22 = "");
202 
203 
204 } // namespace ns3
205 
206 namespace ns3 {
207 
208 template <typename T1>
210 {
211  return MakeAccessorHelper<EnumValue> (a1);
212 }
213 
214 template <typename T1, typename T2>
216 {
217  return MakeAccessorHelper<EnumValue> (a1, a2);
218 }
219 
220 } // namespace ns3
221 
222 #endif /* ENUM_VALUE_H */
Represent the type of an attribute.
Definition: attribute.h:166
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Hold a value for an Attribute.
Definition: attribute.h:68
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: enum.h:209
virtual std::string SerializeToString(Ptr< const AttributeChecker > checker) const
Definition: enum.cc:64
int Get(void) const
Definition: enum.cc:52
Hold variables of type enum.
Definition: enum.h:54
int m_value
The stored integer value.
Definition: enum.h:74
virtual Ptr< AttributeValue > Copy(void) const
Definition: enum.cc:58
ns3::AttributeValue, ns3::AttributeAccessor and ns3::AttributeChecker declarations.
virtual bool DeserializeFromString(std::string value, Ptr< const AttributeChecker > checker)
Definition: enum.cc:82
std::list< std::pair< int, std::string > > ValueSet
Type of container for storing Enum values and symbol names.
Definition: enum.h:113
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void Set(int value)
Set the value.
Definition: enum.cc:46
Ptr< T > Create(void)
Create class instances by constructors with varying numbers of arguments and return them by Ptr...
Definition: ptr.h:516
AttributeChecker implementation for EnumValue.
Definition: enum.h:85
Ptr< const AttributeChecker > MakeEnumChecker(int v1, std::string n1, int v2, std::string n2, int v3, std::string n3, int v4, std::string n4, int v5, std::string n5, int v6, std::string n6, int v7, std::string n7, int v8, std::string n8, int v9, std::string n9, int v10, std::string n10, int v11, std::string n11, int v12, std::string n12, int v13, std::string n13, int v14, std::string n14, int v15, std::string n15, int v16, std::string n16, int v17, std::string n17, int v18, std::string n18, int v19, std::string n19, int v20, std::string n20, int v21, std::string n21, int v22, std::string n22)
Make an EnumChecker pre-configured with a set of allowed values by name.
Definition: enum.cc:184
ValueSet m_valueSet
The stored Enum values and symbol names.
Definition: enum.h:115
ns3::MakeAccessorHelper declarations and template implementations.
bool GetAccessor(T &value) const
Access the Enum value as type T.
Definition: enum.h:79