Float Properties

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

列挙型

enum	IC4_PROPERTY_FLOAT_REPRESENTATION { IC4_PROPFLOATREP_LINEAR , IC4_PROPFLOATREP_LOGARITHMIC , IC4_PROPFLOATREP_PURENUMBER } float プロパティで使用可能な表現形式を定義します。詳細...
enum	IC4_PROPERTY_DISPLAY_NOTATION { IC4_PROPDISPNOTATION_AUTOMATIC , IC4_PROPDISPNOTATION_FIXED , IC4_PROPDISPNOTATION_SCIENTIFIC } float プロパティで使用可能な表示記法を定義します。詳細...

関数

enum IC4_PROPERTY_FLOAT_REPRESENTATION	ic4_prop_float_get_representation (struct IC4_PROPERTY *prop) float プロパティに推奨される表現形式を返します。
const char *	ic4_prop_float_get_unit (struct IC4_PROPERTY *prop) float プロパティの単位を返します。
enum IC4_PROPERTY_DISPLAY_NOTATION	ic4_prop_float_get_display_notation (struct IC4_PROPERTY *prop) float プロパティの値を表示する際に使用する推奨表示記法を返します。
int64_t	ic4_prop_float_get_display_precision (struct IC4_PROPERTY *prop) float プロパティの値を表示する際に使用する推奨有効桁数を返します。
bool	ic4_prop_float_set_value (struct IC4_PROPERTY *prop, double value) float プロパティの値を変更します。
bool	ic4_prop_float_get_value (struct IC4_PROPERTY prop, double pValue) float プロパティの現在の値を読み取ります。
bool	ic4_prop_float_get_min (struct IC4_PROPERTY prop, double pMinimum) float プロパティが受け付ける最小値を返します。
bool	ic4_prop_float_get_max (struct IC4_PROPERTY prop, double pMaximum) float プロパティが受け付ける最大値を返します。
enum IC4_PROPERTY_INCREMENT_MODE	ic4_prop_float_get_inc_mode (struct IC4_PROPERTY *prop) この float プロパティが最小値と最大値の間でどの値を有効とするかを返します。
bool	ic4_prop_float_get_inc (struct IC4_PROPERTY prop, double pIncrement) float プロパティが受け付ける有効な値の刻み幅を返します。
bool	ic4_prop_float_get_valid_value_set (struct IC4_PROPERTY prop, double value_set, size_t *array_size) float の有効な値の集合を返します。

詳細説明

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

float プロパティの代表的な例として AcquisitionFrameRate、ExposureTime、Gain があります。

float プロパティは有効な値の範囲を制限できます。取り得る値の範囲は、ic4_prop_float_get_min() と ic4_prop_float_get_max() を呼び出すことで取得できます。

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

表現形式（ic4_prop_float_get_representation()）
単位（ic4_prop_float_get_unit()）
表示記法（ic4_prop_float_get_display_notation()）
表示精度（ic4_prop_float_get_display_precision()）

列挙型ドキュメント

◆ IC4_PROPERTY_DISPLAY_NOTATION

enum IC4_PROPERTY_DISPLAY_NOTATION

float プロパティで使用可能な表示記法を定義します。

各 float プロパティには、より使いやすいユーザーインターフェイスの作成に役立つ表示記法のヒントがあります。

列挙子
IC4_PROPDISPNOTATION_AUTOMATIC	最適な表示記法を自動的に判定する仕組みを使用します。
IC4_PROPDISPNOTATION_FIXED	固定小数点記法を推奨します。
IC4_PROPDISPNOTATION_SCIENTIFIC	科学記法を推奨します。

◆ IC4_PROPERTY_FLOAT_REPRESENTATION

enum IC4_PROPERTY_FLOAT_REPRESENTATION

float プロパティで使用可能な表現形式を定義します。

各 float プロパティには、より使いやすいユーザーインターフェイスの作成に役立つ表現形式のヒントがあります。

列挙子
IC4_PROPFLOATREP_LINEAR	値を編集するためのスライダーを推奨します。
IC4_PROPFLOATREP_LOGARITHMIC	対数マッピングのスライダーを推奨します。
IC4_PROPFLOATREP_PURENUMBER	数値の表示を推奨します。

関数ドキュメント

◆ ic4_prop_float_get_display_notation()

enum IC4_PROPERTY_DISPLAY_NOTATION ic4_prop_float_get_display_notation ( struct IC4_PROPERTY * prop )

float プロパティの値を表示する際に使用する推奨表示記法を返します。

パラメータ

[in] prop float プロパティ

戻り値: 推奨される表示記法。エラーが発生した場合は IC4_PROPDISPNOTATION_AUTOMATIC。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

◆ ic4_prop_float_get_display_precision()

int64_t ic4_prop_float_get_display_precision ( struct IC4_PROPERTY * prop )

float プロパティの値を表示する際に使用する推奨有効桁数を返します。

パラメータ

[in] prop float プロパティ

戻り値: 表示用に推奨される有効桁数。エラーが発生した場合は既定値。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

◆ ic4_prop_float_get_inc()

bool ic4_prop_float_get_inc	(	struct IC4_PROPERTY *	prop,
		double *	pIncrement
	)

float プロパティが受け付ける有効な値の刻み幅を返します。

刻み幅は、float プロパティの有効な値の集合を制限します。たとえば、プロパティの最小値が 0.0、最大値が 1.0、刻み幅が 0.5 の場合、1.25 はこのプロパティの有効な値ではなく、書き込もうとすると拒否されます。

パラメータ

[in]	prop	float プロパティ
[out]	pIncrement	刻み幅を受け取る double へのポインタ

戻り値: 成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

関連項目: ic4_prop_float_get_min; ic4_prop_float_get_max; ic4_prop_float_has_inc

◆ ic4_prop_float_get_inc_mode()

enum IC4_PROPERTY_INCREMENT_MODE ic4_prop_float_get_inc_mode ( struct IC4_PROPERTY * prop )

この float プロパティが最小値と最大値の間でどの値を有効とするかを返します。

パラメータ

[in] prop float プロパティ

戻り値: プロパティが有効な値の間に固定の刻み幅を持つ場合は IC4_PROPINCMODE_INCREMENT。
プロパティが有効な値の集合を持つ場合は IC4_PROPINCMODE_VALUESET。
プロパティが最小値と最大値の間の任意の値に設定できる場合は IC4_PROPINCMODE_NONE。
エラーが発生した場合、この関数は IC4_PROPINCMODE_NONE を返し、エラー値が設定されます。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

関連項目: ic4_prop_float_get_inc; ic4_prop_float_get_valid_value_set

◆ ic4_prop_float_get_max()

bool ic4_prop_float_get_max	(	struct IC4_PROPERTY *	prop,
		double *	pMaximum
	)

float プロパティが受け付ける最大値を返します。

パラメータ

[in]	prop	float プロパティ
[out]	pMaximum	最大値を受け取る double へのポインタ

戻り値: 成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

関連項目: ic4_prop_integer_get_min; ic4_prop_integer_get_inc

◆ ic4_prop_float_get_min()

bool ic4_prop_float_get_min	(	struct IC4_PROPERTY *	prop,
		double *	pMinimum
	)

float プロパティが受け付ける最小値を返します。

パラメータ

[in]	prop	float プロパティ
[out]	pMinimum	最小値を受け取る double へのポインタ

戻り値: 成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

関連項目: ic4_prop_integer_get_max; ic4_prop_integer_get_inc

◆ ic4_prop_float_get_representation()

enum IC4_PROPERTY_FLOAT_REPRESENTATION ic4_prop_float_get_representation ( struct IC4_PROPERTY * prop )

float プロパティに推奨される表現形式を返します。

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

パラメータ

[in] prop float プロパティ

戻り値: プロパティに推奨される表現形式。エラーの場合は既定の表現形式。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

関連項目: IC4_PROPERTY_FLOAT_REPRESENTATION

◆ ic4_prop_float_get_unit()

const char * ic4_prop_float_get_unit ( struct IC4_PROPERTY * prop )

float プロパティの単位を返します。

パラメータ

[in] prop float プロパティ

戻り値: プロパティの単位。プロパティに単位がない場合は空文字列になることがあります。
エラー情報を取得するには ic4_get_last_error() を使用します。
戻り値が指すメモリは、プロパティオブジェクトが存在する限り有効です。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

◆ ic4_prop_float_get_valid_value_set()

bool ic4_prop_float_get_valid_value_set	(	struct IC4_PROPERTY *	prop,
		double *	value_set,
		size_t *	array_size
	)

float の有効な値の集合を返します。

パラメータ

[in]	prop	値の集合に制限された float プロパティ
[out]	value_set	有効な値の集合を受け取る配列
[in,out]	array_size	`value_set` の長さを示す `size_t` へのポインタ。呼び出し後、これにはこのプロパティの有効な値の集合の要素数が格納されます。

戻り値: 成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。

注意: value_set が NULL でなく array_size が NULL の場合、この関数は失敗し、エラー値に IC4_ERROR_INVALID_PARAM_VAL が設定されます。*array_size がこのプロパティの有効な値の集合の要素数より小さい場合、この関数は失敗し、エラー値に IC4_ERROR_BUFFER_TOO_SMALL が設定されます。prop が有効な値の集合によって制限されていない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_NOT_IMPLEMENTED が設定されます。

◆ ic4_prop_float_get_value()

bool ic4_prop_float_get_value	(	struct IC4_PROPERTY *	prop,
		double *	pValue
	)

float プロパティの現在の値を読み取ります。

パラメータ

[in]	prop	float プロパティ
[out]	pValue	現在の値を受け取る double へのポインタ

戻り値: 成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

◆ ic4_prop_float_set_value()

bool ic4_prop_float_set_value	(	struct IC4_PROPERTY *	prop,
		double	value
	)

float プロパティの値を変更します。

パラメータ

[in]	prop	float プロパティ
[in]	value	設定する新しい値

戻り値: 成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop が float プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。
デバイスまたはコンポーネントが値を拒否した場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_VALUE_ERROR が設定されます。
値が現在書き込み不可の場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_ACCESS_DENIED が設定されます。

関連項目: ic4_prop_float_get_min; ic4_prop_float_get_max; ic4_prop_float_get_inc