C Sharp Flags

From Leo's Notes
Last edited on 24 February 2017, at 19:14.

Defining Flags[edit | edit source]

[Flags]
public enum  State {
   Idle = 0x01,
   Available = 0x02,
   InService = 0x04,
   
   Accelerating = 0x08,
   Decelerating = 0x10,
   Stopped = 0x20,
}

Notice that the flags are given values of powers of two.

Operations[edit | edit source]

Setting a Flag[edit | edit source]

Use the bit-wise OR operation to set (add) a flag.

State state = State.Available;
state = state | State.Stopped;

state now has both Available and Stopped. The actual value of state is 0x22 (from 0x02 + 0x22)

Removing a Flag[edit | edit source]

Use the bit-wise XOR (^) operation to unset (remove) a flag.

State state = State.Available | State.Stopped;
state = state ^ State.Available;
state = state ^ State.Stopped;
state = state | State.InService;

state is now InService. The actual value of state is 0x04.

Checking[edit | edit source]

Use the bit-wise AND operation to do checking.

State state = State.Available | State.Stopped;

if ((state & State.Idle) == State.Idle) {
   // This will fail as state is set to Available and Stopped.
}

or use the HasFlag() method.