Class PropFloat

Float プロパティは、値が浮動小数点数である機能を表します。

継承

object
HandleObject
Property
PropFloat

実装

継承されたメンバ

Namespace: ic4
Assembly: ic4dotnet.dll

構文

public class PropFloat : Property, IDisposable

解説

Floatプロパティの一般的な例としては、AcquisitionFrameRate、ExposureTime、Gain などがあります。
Floatプロパティでは、有効な値の範囲を制限できます。取り得る値の範囲は、Minimum および Maximum を読み取ることで取得できます。
さらに、インクリメント値や有効値セットによって、使用可能な値を制限することもできます。IncrementMode、Increment、ValidValueSet を確認してください。

Float プロパティは、ユーザーインターフェース作成時に役立つヒントを提供します。

PropFloat のインスタンスは、以下の方法で生成されます。

プロパティ

DisplayNotation

Float プロパティの値を表示する際に使用する、推奨される表示形式です。

宣言

public DisplayNotation DisplayNotation { get; }

プロパティ値

型 説明
DisplayNotation Float プロパティの値を表示する際に使用する、推奨される表示形式です。
備考

表示精度は、ユーザーインターフェースを作成する際のヒントとして使用できます。

DisplayPrecision

Float プロパティの値を表示する際に使用する、有効桁数の目安です。

宣言

public long DisplayPrecision { get; }

プロパティ値

型 説明
long Float プロパティの値を表示する際に使用する、有効桁数の目安です。
備考

表示精度は、ユーザーインターフェースを作成する際のヒントとして使用できます。

Increment

この浮動小数点プロパティで受け付けられる有効な値のステップサイズです。

宣言

public double Increment { get; }

プロパティ値

型 説明
double この浮動小数点プロパティで受け付けられる有効な値のステップサイズ
備考

Increment は、浮動小数点プロパティにおける有効な値の集合を制限します。
例えば、プロパティの最小値が 0、最大値が 10、Increment が 0.5 の場合、0.25 はこのプロパティの有効な値ではありません。
IncrementMode が Increment と等しくない場合、Increment にアクセスすると例外がスローされます。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

IncrementMode

この浮動小数点プロパティが、最小値と最大値の間でどのように有効な値を制限するかを示します。

宣言

public PropertyIncrementMode IncrementMode { get; }

プロパティ値

型 説明
PropertyIncrementMode このプロパティのインクリメントモード
備考

浮動小数点プロパティには、次の 3 種類のインクリメントモードがあります。

インクリメントモード 説明
None 制限はなく、Minimum とMaximum の間のすべての値を設定できます。
Increment Increment の倍数の値のみを設定できます。
ValueSet ValidValueSet に含まれる値のみを設定できます。

Maximum

このプロパティで受け付けられる最大値。

宣言

public double Maximum { get; }

プロパティ値

型 説明
double このプロパティで受け付けられる最大値。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

Minimum

このプロパティで受け付けられる最小値。

宣言

public double Minimum { get; }

プロパティ値

型 説明
double このプロパティで受け付けられる最小値。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

Representation

この浮動小数点プロパティに対して推奨される表現形式。

宣言

public FloatRepresentation Representation { get; }

プロパティ値

型 説明
FloatRepresentation この浮動小数点プロパティに対して推奨される表現形式
備考

この表現形式は、ユーザーインターフェースを作成する際のヒントとして利用できます。

Unit

このFloatプロパティの単位。

宣言

public string Unit { get; }

プロパティ値

型 説明
string このFloatプロパティの単位。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

ValidValueSet

このプロパティで有効な値の集合

宣言

public IReadOnlyList<double> ValidValueSet { get; }

プロパティ値

型 説明
IReadOnlyList<double> このプロパティに対して有効な値を含むリスト
備考

IncrementMode が ValueSet と等しくない場合、ValidValueSet にアクセスすると例外がスローされます。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

Value

このプロパティの現在の値です。
この値は、プロパティの書き込み可否が制限されていない場合にのみ書き込み可能です。IsLocked、 IsReadonly、 IsAvailable を参照してください。

宣言

public double Value { get; set; }

プロパティ値

型 説明
double このプロパティの現在の値

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

メソッド

TryGetValue(out double)

プロパティの現在の値を取得しようとします。

宣言

public bool TryGetValue(out double val)

パラメータ

型 名前 説明
double val 成功した場合に、このプロパティの現在の値を受け取る出力パラメータ

戻り値

型 説明
bool 操作が成功した場合は true、それ以外の場合は false。
備考

Value プロパティを直接読み取る場合とは異なり、 このメソッドはエラーが発生しても例外をスローしません。

TrySetValue(double)

プロパティの現在の値を設定しようとします。

宣言

public bool TrySetValue(double val)

パラメータ

型 名前 説明
double val 設定する新しい値

戻り値

型 説明
bool 操作が成功した場合は true、それ以外の場合は false。
備考

Value プロパティに直接書き込む場合とは異なり、 このメソッドはエラーが発生しても例外をスローしません。

実装

IDisposable