FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
enum_base.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef __VOM_ENUM_H__
17 #define __VOM_ENUM_H__
18 
19 #include <string>
20 
21 namespace VOM {
22 /**
23  * A template base class for all enum types.
24  * This enum type exists to associate an enum value with a string for
25  * display/debug purposes.
26  * Concrete enum types use the CRTP. Derived classes thus inherit this
27  * base's function, but are not polymorphic.
28  */
29 template <typename T>
30 class enum_base
31 {
32 public:
33  /**
34  * convert to string format for debug purposes
35  */
36  const std::string& to_string() const { return (m_desc); }
37 
38  /**
39  * Comparison operator
40  */
41  bool operator==(const enum_base& e) const { return (e.m_value == m_value); }
42 
43  /**
44  * Assignment
45  */
47  {
48  m_value = e.m_value;
49  m_desc = e.m_desc;
50 
51  return (*this);
52  }
53 
54  /**
55  * bitwise or assignemnt
56  */
58  {
59  m_value += e.m_value;
60  m_desc += ":" + e.m_desc;
61 
62  return *this;
63  }
64 
65  /**
66  * bitwise or
67  */
68  enum_base operator|(const enum_base& e1) const
69  {
70  enum_base e = *this;
71  e |= e1;
72  return e;
73  }
74 
75  /**
76  * Comparison operator
77  */
78  bool operator!=(const enum_base& e) const { return (e.m_value != m_value); }
79 
80  /**
81  * integer conversion operator
82  */
83  operator int() const { return (m_value); }
84 
85  /**
86  * Return the value of the enum - same as integer conversion
87  */
88  int value() const { return (m_value); }
89 
90 protected:
91  /**
92  * Constructor of an enum - takes value and string description
93  */
94  enum_base(int value, const std::string desc)
95  : m_value(value)
96  , m_desc(desc)
97  {
98  }
99 
100  /**
101  * Constructor
102  */
103  virtual ~enum_base() {}
104 
105 private:
106  /**
107  * Integer value of the enum
108  */
109  int m_value;
110 
111  /**
112  * String description
113  */
114  std::string m_desc;
115 };
116 };
117 
118 /*
119  * fd.io coding-style-patch-verification: OFF
120  *
121  * Local Variables:
122  * eval: (c-set-style "mozilla")
123  * End:
124  */
125 
126 #endif
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::enum_base::operator==
bool operator==(const enum_base &e) const
Comparison operator.
Definition: enum_base.hpp:41
VOM::enum_base::operator|=
enum_base & operator|=(const enum_base &e)
bitwise or assignemnt
Definition: enum_base.hpp:57
VOM::enum_base::operator|
enum_base operator|(const enum_base &e1) const
bitwise or
Definition: enum_base.hpp:68
VOM::enum_base::enum_base
enum_base(int value, const std::string desc)
Constructor of an enum - takes value and string description.
Definition: enum_base.hpp:94
VOM::enum_base::value
int value() const
Return the value of the enum - same as integer conversion.
Definition: enum_base.hpp:88
VOM::enum_base
A template base class for all enum types.
Definition: enum_base.hpp:30
VOM::enum_base::~enum_base
virtual ~enum_base()
Constructor.
Definition: enum_base.hpp:103
VOM::enum_base::to_string
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
VOM::enum_base::operator=
enum_base & operator=(const enum_base &e)
Assignment.
Definition: enum_base.hpp:46
VOM::enum_base::operator!=
bool operator!=(const enum_base &e) const
Comparison operator.
Definition: enum_base.hpp:78
string
const char *const string
Definition: cJSON.h:172