Integer Properties

Integer プロパティは、値が整数である機能を表します。 詳細...

列挙型

enum  IC4_PROPERTY_INT_REPRESENTATION {
  IC4_PROPINTREP_LINEAR , IC4_PROPINTREP_LOGARITHMIC , IC4_PROPINTREP_BOOLEAN , IC4_PROPINTREP_PURENUMBER ,
  IC4_PROPINTREP_HEXNUMBER , IC4_PROPINTREP_IPV4ADDRESS , IC4_PROPINTREP_MACADDRESS
}

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

関数

enum IC4_PROPERTY_INT_REPRESENTATION ic4_prop_integer_get_representation (struct IC4_PROPERTY *prop)

integer プロパティに推奨される表現形式を返します。
const char * ic4_prop_integer_get_unit (struct IC4_PROPERTY *prop)

integer プロパティの単位を返します。
bool ic4_prop_integer_set_value (struct IC4_PROPERTY *prop, int64_t value)

integer プロパティの値を変更します。
bool ic4_prop_integer_get_value (struct IC4_PROPERTY *prop, int64_t *pValue)

integer プロパティの現在の値を読み取ります。
bool ic4_prop_integer_get_min (struct IC4_PROPERTY *prop, int64_t *pMinimum)

integer プロパティが受け付ける最小値を返します。
bool ic4_prop_integer_get_max (struct IC4_PROPERTY *prop, int64_t *pMaximum)

integer プロパティが受け付ける最大値を返します。
bool ic4_prop_integer_get_inc (struct IC4_PROPERTY *prop, int64_t *pIncrement)

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

enum IC4_PROPERTY_INCREMENT_MODE ic4_prop_integer_get_inc_mode (struct IC4_PROPERTY *prop)

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

bool ic4_prop_integer_get_valid_value_set (struct IC4_PROPERTY *prop, int64_t *value_set, size_t *array_size)

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

詳細説明

Integer プロパティは、値が整数である機能を表します。

integer プロパティの代表的な例として Width や Height があります。

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

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

列挙型ドキュメント

◆ IC4_PROPERTY_INT_REPRESENTATION

enum IC4_PROPERTY_INT_REPRESENTATION

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

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

列挙子
IC4_PROPINTREP_LINEAR 

値を編集するためのスライダーを推奨します。

IC4_PROPINTREP_LOGARITHMIC 

対数マッピングのスライダーを推奨します。

IC4_PROPINTREP_BOOLEAN 

チェックボックスを推奨します。

IC4_PROPINTREP_PURENUMBER 

10進数の表示を推奨します。

IC4_PROPINTREP_HEXNUMBER 

16進数の表示を推奨します。

IC4_PROPINTREP_IPV4ADDRESS 

整数を IPV4 アドレスとして扱うことを推奨します。

IC4_PROPINTREP_MACADDRESS 

整数を MAC アドレスとして扱うことを推奨します。

関数ドキュメント

◆ ic4_prop_integer_get_inc()

bool ic4_prop_integer_get_inc ( struct IC4_PROPERTY *  prop,
int64_t *  pIncrement 
)

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

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

パラメータ
[in]propinteger プロパティ
[out]pIncrement刻み幅を受け取る整数へのポインタ
戻り値
成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。
関連項目
ic4_prop_integer_get_min
ic4_prop_integer_get_max

◆ ic4_prop_integer_get_inc_mode()

enum IC4_PROPERTY_INCREMENT_MODE ic4_prop_integer_get_inc_mode ( struct IC4_PROPERTY *  prop)

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

パラメータ
[in]propinteger プロパティ
戻り値
プロパティが有効な値の間に固定の刻み幅を持つ場合は IC4_PROPINCMODE_INCREMENT。
プロパティが有効な値の集合を持つ場合は IC4_PROPINCMODE_VALUESET。
エラーが発生した場合、この関数は IC4_PROPINCMODE_INCREMENT を返し、エラー値が設定されます。
エラー情報を取得するには ic4_get_last_error() を使用します。
関連項目
ic4_prop_integer_get_inc
ic4_prop_integer_get_valid_value_set

◆ ic4_prop_integer_get_max()

bool ic4_prop_integer_get_max ( struct IC4_PROPERTY *  prop,
int64_t *  pMaximum 
)

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

パラメータ
[in]propinteger プロパティ
[out]pMaximum最大値を受け取る整数へのポインタ
戻り値
成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。
関連項目
ic4_prop_integer_get_min
ic4_prop_integer_get_inc

◆ ic4_prop_integer_get_min()

bool ic4_prop_integer_get_min ( struct IC4_PROPERTY *  prop,
int64_t *  pMinimum 
)

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

パラメータ
[in]propinteger プロパティ
[out]pMinimum最小値を受け取る整数へのポインタ
戻り値
成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。
関連項目
ic4_prop_integer_get_max
ic4_prop_integer_get_inc

◆ ic4_prop_integer_get_representation()

enum IC4_PROPERTY_INT_REPRESENTATION ic4_prop_integer_get_representation ( struct IC4_PROPERTY *  prop)

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

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

パラメータ
[in]propinteger プロパティ
戻り値
プロパティに推奨される表現形式。エラーの場合は既定の表現形式。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。
関連項目
IC4_PROPERTY_INT_REPRESENTATION

◆ ic4_prop_integer_get_unit()

const char * ic4_prop_integer_get_unit ( struct IC4_PROPERTY *  prop)

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

パラメータ
[in]propinteger プロパティ
戻り値
プロパティの単位。プロパティに単位がない場合は空文字列になることがあります。
戻り値が指すメモリは、プロパティオブジェクトが存在する限り有効です。
エラーが発生した場合、この関数は NULL を返します。エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

◆ ic4_prop_integer_get_valid_value_set()

bool ic4_prop_integer_get_valid_value_set ( struct IC4_PROPERTY *  prop,
int64_t *  value_set,
size_t *  array_size 
)

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

パラメータ
[in]prop値の集合に制限された integer プロパティ
[out]value_set有効な値の集合を受け取る配列
[in,out]array_sizevalue_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_integer_get_value()

bool ic4_prop_integer_get_value ( struct IC4_PROPERTY *  prop,
int64_t *  pValue 
)

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

パラメータ
[in]propinteger プロパティ
[out]pValue現在の値を受け取る整数へのポインタ
戻り値
成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。

◆ ic4_prop_integer_set_value()

bool ic4_prop_integer_set_value ( struct IC4_PROPERTY *  prop,
int64_t  value 
)

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

パラメータ
[in]propinteger プロパティ
[in]value設定する新しい値
戻り値
成功した場合は true、それ以外の場合は false。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が integer プロパティでない場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_TYPE_MISMATCH が設定されます。
デバイスまたはコンポーネントが値を拒否した場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_VALUE_ERROR が設定されます。
値が現在書き込み不可の場合、この関数は失敗し、エラー値に IC4_ERROR_GENICAM_ACCESS_DENIED が設定されます。
関連項目
ic4_prop_integer_get_min
ic4_prop_integer_get_max
ic4_prop_integer_get_inc