Flag.hpp 3.23 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
#pragma once

namespace AMDiS
{
  /** \ingroup Common
   * \brief
   * The Flag class encapsulates flags which represents simple information.
   * Used e.g. while mesh traversal to specify, which elements should be
   * visited.
   */
  class Flag
  {
  public:
    /// Constructs a unset Flag
    Flag() : flags(0) {}

    /// Constructs a Flag initialized by f
    Flag(const unsigned long f) : flags(f) {}

    /// Copy constructor
    Flag(Flag const& f) : flags(f.flags) {}

    /// Compares two Flags
    bool operator==(Flag const& f) const
    {
      return (flags == f.flags);
    }

    /// Compares two Flags
    bool operator!=(Flag const& f) const
    {
      return !(f == *this);
    }

    /// Assignment operator
    Flag& operator=(Flag const& f)
    {
      if (this != &f)
        flags = f.flags;
      return *this;
    }

    /// Typecast
    operator bool() const
    {
      return isAnySet();
    }

    /// Set \ref flags
    void setFlags(const unsigned long f)
    {
      flags = f;
    }

    /// Set \ref flags
    void setFlags(Flag const& f)
    {
      flags = f.flags;
    }

    /// Sets \ref flags to \ref flags | f
    void setFlag(const unsigned long f)
    {
      flags |= f;
    }

    /// Sets \ref flags to \ref flags | f.flags
    void setFlag(Flag const& f)
    {
      flags |= f.flags;
    }

    /// Sets \ref flags to \ref flags & ~f
    void unsetFlag(const unsigned long f)
    {
      flags &= ~f;
    }

    /// Sets \ref flags to \ref flags & ~f.flags
    void unsetFlag(Flag const& f)
    {
      flags &= ~f.flags;
    }

    unsigned long getFlags() const
    {
      return flags;
    }

    /// Returns \ref flags | f.flags
    Flag operator+(Flag const& f) const
    {
      Flag r(flags);
      r.setFlag(f);
      return r;
    }

    /// Returns \ref flags & ~f.flags
    Flag operator-(Flag const& f) const
    {
      Flag r(flags);
      r.unsetFlag(f);
      return r;
    }

    /// Returns \ref flags | f.flags
    Flag operator|(Flag const& f) const
    {
      Flag r(flags);
      r.setFlag(f);
      return r;
    }

    /// Returns \ref flags & f.flags
    Flag operator&(Flag const& f) const
    {
      Flag r(flags);
      r.flags &= f.flags;
      return r;
    }

    /// Sets \ref flags to \ref flags &= f.flags
    Flag operator&=(Flag const& f)
    {
      flags &= f.flags;
      return *this;
    }

    /// Returns \ref flags ^ f.flags
    Flag operator^(Flag const& f) const
    {
      Flag r(flags);
      r.flags ^= f.flags;
      return r;
    }

    /// Sets \ref flags to \ref flags & f.flags
    Flag& operator|=(Flag const& f)
    {
      if (this != &f)
        flags |= f.flags;
      return *this;
    }

    /// Returns ~\ref flags
    Flag operator~() const
    {
      Flag r;
      r.flags = ~flags;
      return r;
    }

    /// Checks whether all set bits of f.flags are set in \ref flags too.
    bool isSet(Flag const& f) const
    {
      return ((flags&f.flags) == f.flags);
    }

    /// Returns !\ref isSet(f)
    bool isUnset(Flag const& f) const
    {
      return !isSet(f);
    }

    /// Returns true if \ref flags != 0
    bool isAnySet() const
    {
      return (flags != 0);
    }

  protected:
    /// Internal flag representation
    unsigned long  flags;
  };

} // end namespace AMDiS