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
33namespace ns3 {
34
35// Additional docs for class EnumValue:
55{
56public:
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
73private:
74 int m_value;
75};
76
77template <typename T>
78bool
79EnumValue::GetAccessor (T &value) const
80{
81 value = T (m_value);
82 return true;
83}
84
86{
87public:
88 EnumChecker ();
89
95 void AddDefault (int value, std::string name);
101 void Add (int value, std::string name);
102
108 std::string GetName (int value) const;
109
115 int GetValue (const std::string name) const;
116
117 // Inherited
118 virtual bool Check (const AttributeValue &value) const;
119 virtual std::string GetValueTypeName (void) const;
120 virtual bool HasUnderlyingTypeInformation (void) const;
121 virtual std::string GetUnderlyingTypeInformation (void) const;
122 virtual Ptr<AttributeValue> Create (void) const;
123 virtual bool Copy (const AttributeValue &src, AttributeValue &dst) const;
124
125private:
127 typedef std::pair<int,std::string> Value;
129 typedef std::list<Value> ValueSet;
132};
133
134template <typename T1>
136
137template <typename T1, typename T2>
139
160template <typename... Ts>
162MakeEnumChecker (int v, std::string n, Ts... args)
163{
164 Ptr<EnumChecker> checker = Create<EnumChecker> ();
165 checker->AddDefault (v, n);
166 return MakeEnumChecker (checker, args...);
167}
168
181template <typename... Ts>
182Ptr<const AttributeChecker>
183MakeEnumChecker (Ptr<EnumChecker> checker, int v, std::string n, Ts... args)
184{
185 checker->Add (v, n);
186 return MakeEnumChecker (checker, args...);
187}
188
195// inline to allow tail call optimization
196inline
197Ptr<const AttributeChecker>
199{
200 return checker;
201}
202
203
204template <typename T1>
206{
207 return MakeAccessorHelper<EnumValue> (a1);
208}
209
210template <typename T1, typename T2>
212{
213 return MakeAccessorHelper<EnumValue> (a1, a2);
214}
215
216} // namespace ns3
217
218#endif /* ENUM_VALUE_H */
ns3::MakeAccessorHelper declarations and template implementations.
ns3::AttributeValue, ns3::AttributeAccessor and ns3::AttributeChecker declarations.
Represent the type of an attribute.
Definition: attribute.h:167
Hold a value for an Attribute.
Definition: attribute.h:69
AttributeChecker implementation for EnumValue.
Definition: enum.h:86
virtual bool Copy(const AttributeValue &src, AttributeValue &dst) const
Copy the source to the destination.
Definition: enum.cc:176
virtual Ptr< AttributeValue > Create(void) const
Definition: enum.cc:169
void Add(int value, std::string name)
Add a new value.
Definition: enum.cc:96
virtual bool Check(const AttributeValue &value) const
Definition: enum.cc:130
ValueSet m_valueSet
The stored Enum values and symbol names.
Definition: enum.h:131
int GetValue(const std::string name) const
Get the enum value by name.
Definition: enum.cc:111
virtual std::string GetUnderlyingTypeInformation(void) const
Definition: enum.cc:156
std::pair< int, std::string > Value
Type for the pair value, name.
Definition: enum.h:127
std::string GetName(int value) const
Get the enum symbol name by value.
Definition: enum.cc:102
virtual std::string GetValueTypeName(void) const
Definition: enum.cc:144
void AddDefault(int value, std::string name)
Add a default value.
Definition: enum.cc:90
std::list< Value > ValueSet
Type of container for storing Enum values and symbol names.
Definition: enum.h:129
virtual bool HasUnderlyingTypeInformation(void) const
Definition: enum.cc:150
Hold variables of type enum.
Definition: enum.h:55
bool GetAccessor(T &value) const
Access the Enum value as type T.
Definition: enum.h:79
void Set(int value)
Set the value.
Definition: enum.cc:48
virtual std::string SerializeToString(Ptr< const AttributeChecker > checker) const
Definition: enum.cc:66
int Get(void) const
Definition: enum.cc:54
virtual bool DeserializeFromString(std::string value, Ptr< const AttributeChecker > checker)
Definition: enum.cc:75
int m_value
The stored integer value.
Definition: enum.h:74
virtual Ptr< AttributeValue > Copy(void) const
Definition: enum.cc:60
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Definition: enum.h:205
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeEnumChecker(int v, std::string n, Ts... args)
Make an EnumChecker pre-configured with a set of allowed values by name.
Definition: enum.h:162