時々、次のような列挙型が表示されます。
[Flags]
public enum Options
{
None = 0,
Option1 = 1,
Option2 = 2,
Option3 = 4,
Option4 = 8
}
[Flags]
属性が何をするのか正確にはわかりません。
誰かが投稿できる良い説明や例がありますか?
[Flags]
列挙型が単一の値ではなく、可能な値のコレクションを表す場合は常に、この属性を使用する必要があります。このようなコレクションは、多くの場合、ビットごとの演算子で使用されます。次に例を示します。
var allowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;
[Flags]
属性はそれ自体ではこれを有効にしないことに注意してください-.ToString()
メソッドによる適切な表現を許可するだけです:
enum Suits { Spades = 1, Clubs = 2, Diamonds = 4, Hearts = 8 }
[Flags] enum SuitsFlags { Spades = 1, Clubs = 2, Diamonds = 4, Hearts = 8 }
...
var str1 = (Suits.Spades | Suits.Diamonds).ToString();
// "5"
var str2 = (SuitsFlags.Spades | SuitsFlags.Diamonds).ToString();
// "Spades, Diamonds"
が自動的に列挙値を 2 の累乗に[Flags]
しないことに注意することも重要です。数値を省略すると、デフォルトでは値が 0 から始まりインクリメントされるため、列挙型はビット演算で期待されるようには機能しません。
間違った宣言:
[Flags]
public enum MyColors
{
Yellow, // 0
Green, // 1
Red, // 2
Blue // 3
}
このように宣言された場合、値は黄 = 0、緑 = 1、赤 = 2、青 = 3 になります。これにより、フラグとして役に立たなくなります。
正しい宣言の例を次に示します。
[Flags]
public enum MyColors
{
Yellow = 1,
Green = 2,
Red = 4,
Blue = 8
}
プロパティの個別の値を取得するには、次のようにします。
if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
// Yellow is allowed...
}
または .NET 4 より前:
if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
// Yellow is allowed...
}
if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
// Green is allowed...
}
カバーの下に
これは、列挙で 2 の累乗を使用したために機能します。内部では、列挙値はバイナリの 1 と 0 で次のようになります。
Yellow: 00000001
Green: 00000010
Red: 00000100
Blue: 00001000
同様に、バイナリ ビットごとの OR演算子を使用してプロパティAllowedColorsを赤、緑、および青に設定すると、 AllowedColorsは次のようになります。|
myProperties.AllowedColors: 00001110
したがって、値を取得するとき、実際&
には値に対してビットごとの AND を実行しています。
myProperties.AllowedColors: 00001110
MyColor.Green: 00000010
-----------------------
00000010 // Hey, this is the same as MyColor.Green!
None = 0 の値
また、列挙での使用については、0
MSDN から引用します。
[Flags]
public enum MyColors
{
None = 0,
....
}
値がゼロのフラグ列挙定数の名前として None を使用します。ビットごとの AND 演算で None 列挙型定数を使用してフラグをテストすることはできません。これは、結果が常に 0 であるためです。ただし、数値と None 列挙定数との間で、ビット単位ではなく論理比較を実行して、数値のビットが設定されているかどうかを判断できます。
flags 属性とその使用法についての詳細はmsdnで、フラグの設計については msdn で見つけることができます。
これを行うこともできます
[Flags]
public enum MyEnum
{
None = 0,
First = 1 << 0,
Second = 1 << 1,
Third = 1 << 2,
Fourth = 1 << 3
}
4、8、16、32 などと入力するよりもビットシフトの方が簡単だと思います。すべてコンパイル時に行われるため、コードに影響はありません。
回答https://stackoverflow.com/a/8462/1037948 (ビットシフトによる宣言) とhttps://stackoverflow.com/a/9117/1037948 (宣言で組み合わせを使用) を組み合わせると、以前の値をビットシフトすることができます。数字を使うよりも 必ずしも推奨するわけではありませんが、できることを指摘するだけです。
それよりも:
[Flags]
public enum Options : byte
{
None = 0,
One = 1 << 0, // 1
Two = 1 << 1, // 2
Three = 1 << 2, // 4
Four = 1 << 3, // 8
// combinations
OneAndTwo = One | Two,
OneTwoAndThree = One | Two | Three,
}
あなたは宣言することができます
[Flags]
public enum Options : byte
{
None = 0,
One = 1 << 0, // 1
// now that value 1 is available, start shifting from there
Two = One << 1, // 2
Three = Two << 1, // 4
Four = Three << 1, // 8
// same combinations
OneAndTwo = One | Two,
OneTwoAndThree = One | Two | Three,
}
LinqPad で確認:
foreach(var e in Enum.GetValues(typeof(Options))) {
string.Format("{0} = {1}", e.ToString(), (byte)e).Dump();
}
結果:
None = 0
One = 1
Two = 2
OneAndTwo = 3
Three = 4
OneTwoAndThree = 7
Four = 8
宣言と潜在的な使用法を示す例については、次を参照してください。
namespace Flags
{
class Program
{
[Flags]
public enum MyFlags : short
{
Foo = 0x1,
Bar = 0x2,
Baz = 0x4
}
static void Main(string[] args)
{
MyFlags fooBar = MyFlags.Foo | MyFlags.Bar;
if ((fooBar & MyFlags.Foo) == MyFlags.Foo)
{
Console.WriteLine("Item has Foo flag set");
}
}
}
}
私は最近、似たようなことについて尋ねました。
フラグを使用する場合は、列挙型に拡張メソッドを追加して、含まれているフラグのチェックを簡単にすることができます (詳細については投稿を参照してください)。
これにより、次のことが可能になります。
[Flags]
public enum PossibleOptions : byte
{
None = 0,
OptionOne = 1,
OptionTwo = 2,
OptionThree = 4,
OptionFour = 8,
//combinations can be in the enum too
OptionOneAndTwo = OptionOne | OptionTwo,
OptionOneTwoAndThree = OptionOne | OptionTwo | OptionThree,
...
}
次に、次のことができます。
PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree
if( opt.IsSet( PossibleOptions.OptionOne ) ) {
//optionOne is one of those set
}
これは、含まれているフラグをチェックするほとんどの方法よりも読みやすいと思います。
@ニドノク
既存の値のセットに別のフラグを追加するには、OR 代入演算子を使用します。
Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
&& ((Mode & Mode.Read) == Mode.Read)));
追加するにはMode.Write
:
Mode = Mode | Mode.Write;
特にANDが両方ともフラグの複合セットであり、オーバーラップがあるかどうかだけを知りたい場合はif ((x & y) == y)...
特に、構造について私には非常に冗長なことがあります。x
y
この場合、実際に知る必要があるのは、ビットマスクした後にゼロ以外の値 [1] があるかどうかだけです。
[1] ハイメのコメントを参照してください。本当に bitmaskingしていれば、結果が正であることを確認するだけで済みます。しかし、 s は負になる可能性があるため、奇妙なことに、 属性と
enum
組み合わせると、 .ではなく.[Flags]
!= 0
> 0
@andnil のセットアップから構築しています...
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace BitFlagPlay
{
class Program
{
[Flags]
public enum MyColor
{
Yellow = 0x01,
Green = 0x02,
Red = 0x04,
Blue = 0x08
}
static void Main(string[] args)
{
var myColor = MyColor.Yellow | MyColor.Blue;
var acceptableColors = MyColor.Yellow | MyColor.Red;
Console.WriteLine((myColor & MyColor.Blue) != 0); // True
Console.WriteLine((myColor & MyColor.Red) != 0); // False
Console.WriteLine((myColor & acceptableColors) != 0); // True
// ... though only Yellow is shared.
Console.WriteLine((myColor & MyColor.Green) != 0); // Wait a minute... ;^D
Console.Read();
}
}
}
フラグを使用すると、列挙内でビットマスキングを使用できます。これにより、指定された値を保持しながら、列挙値を組み合わせることができます。
[Flags]
public enum DashboardItemPresentationProperties : long
{
None = 0,
HideCollapse = 1,
HideDelete = 2,
HideEdit = 4,
HideOpenInNewWindow = 8,
HideResetSource = 16,
HideMenu = 32
}