Enumeration Properties

Enumeration Propertyは、名前付きエントリのリストから値を選択する機能を表します。 詳細...

関数

bool ic4_prop_enum_get_entries (struct IC4_PROPERTY *prop, struct IC4_PROPERTY_LIST **ppList)

このEnumeration Property内のエントリのリストを返します。

bool ic4_prop_enum_find_entry_by_name (struct IC4_PROPERTY *prop, const char *entry_name, struct IC4_PROPERTY **ppEntry)

このEnumeration Property内で、指定された名前を持つenumeration entryを検索します。

bool ic4_prop_enum_find_entry_by_value (struct IC4_PROPERTY *prop, int64_t entry_value, struct IC4_PROPERTY **ppEntry)

このEnumeration Property内で、指定された値を持つenumeration entryを検索します。

bool ic4_prop_enum_set_value (struct IC4_PROPERTY *prop, const char *entry_name)

列挙の選択エントリを名前で設定します。
const char * ic4_prop_enum_get_value (struct IC4_PROPERTY *prop)

列挙で現在選択されているエントリの名前を返します。
bool ic4_prop_enum_set_selected_entry (struct IC4_PROPERTY *prop, struct IC4_PROPERTY *entry)

列挙の選択エントリを設定します。
bool ic4_prop_enum_get_selected_entry (struct IC4_PROPERTY *prop, struct IC4_PROPERTY **ppEntry)

このEnumeration Propertyで現在選択されているエントリを返します。
bool ic4_prop_enum_set_int_value (struct IC4_PROPERTY *prop, int64_t entry_value)

エントリの値を指定して、このEnumeration Propertyで現在選択されているエントリを選択します。
bool ic4_prop_enum_get_int_value (struct IC4_PROPERTY *prop, int64_t *pValue)

Enumeration Propertyで現在選択されているエントリの値を返します。
bool ic4_prop_enumentry_get_int_value (struct IC4_PROPERTY *prop, int64_t *pValue)

enumeration entryの値を返します。

詳細説明

Enumeration Propertyは、名前付きエントリのリストから値を選択する機能を表します。

Enumeration Propertyの一般的な例としては、PixelFormat、TriggerMode、ExposureAuto などがあります。

Enumeration Propertyの値は、enumeration entryの名前または値のいずれによっても取得・設定できます。

enumeration entryは IC4_PROPERTY オブジェクトで表されます。ic4_prop_enum_get_entries() を呼び出すと、指定可能なenumeration entryのリストが IC4_PROPERTY_LIST として返されます。

関数ドキュメント

◆ ic4_prop_enum_find_entry_by_name()

bool ic4_prop_enum_find_entry_by_name ( struct IC4_PROPERTY *  prop,
const char *  entry_name,
struct IC4_PROPERTY **  ppEntry 
)

このEnumeration Property内で、指定された名前を持つenumeration entryを検索します。

パラメータ
[in]propEnumerationプロパティ
[in]entry_nameこのEnumeration Propertyのenumeration entryのいずれかの名前
[out]ppEntry要求されたenumeration entryを受け取るプロパティへのポインタです。
enumeration entryが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
関連項目
ic4_prop_enum_find_entry_by_value

◆ ic4_prop_enum_find_entry_by_value()

bool ic4_prop_enum_find_entry_by_value ( struct IC4_PROPERTY *  prop,
int64_t  entry_value,
struct IC4_PROPERTY **  ppEntry 
)

このEnumeration Property内で、指定された値を持つenumeration entryを検索します。

パラメータ
[in]propEnumerationプロパティ
[in]entry_valueこのEnumeration Propertyのenumeration entryのいずれかの値
[out]ppEntry要求されたenumeration entryを受け取るプロパティへのポインタです。
enumeration entryが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
関連項目
ic4_prop_enum_find_entry_by_name

◆ ic4_prop_enum_get_entries()

bool ic4_prop_enum_get_entries ( struct IC4_PROPERTY *  prop,
struct IC4_PROPERTY_LIST **  ppList 
)

このEnumeration Property内のエントリのリストを返します。

パラメータ
[in]propEnumerationプロパティ
[out]ppListenumeration entryのリストを受け取るPropertyListへのポインタです。
PropertyListが不要になったら、ic4_proplist_unref() を使用してオブジェクト参照を解放してください。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_prop_enum_get_int_value()

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

Enumeration Propertyで現在選択されているエントリの値を返します。

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

◆ ic4_prop_enum_get_selected_entry()

bool ic4_prop_enum_get_selected_entry ( struct IC4_PROPERTY *  prop,
struct IC4_PROPERTY **  ppEntry 
)

このEnumeration Propertyで現在選択されているエントリを返します。

パラメータ
[in]propEnumerationプロパティ
[out]ppEntry現在選択されているenumeration entryを受け取るプロパティへのポインタです。
enumeration entryが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
関連項目
ic4_prop_enum_get_int_value

◆ ic4_prop_enum_get_value()

const char * ic4_prop_enum_get_value ( struct IC4_PROPERTY *  prop)

列挙で現在選択されているエントリの名前を返します。

パラメータ
propEnumerationプロパティ
戻り値
列挙で現在選択されているエントリの名前、またはエラーの場合は NULL を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
戻り値が指すメモリは、少なくともプロパティオブジェクトが存在する限り、またはこの列挙に対して次に ic4_prop_enum_get_value が呼び出されるまで有効です。
備考
prop が Enumeration プロパティでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_prop_enum_set_int_value()

bool ic4_prop_enum_set_int_value ( struct IC4_PROPERTY *  prop,
int64_t  entry_value 
)

エントリの値を指定して、このEnumeration Propertyで現在選択されているエントリを選択します。

このメソッドは、既知のenumeration entryを直接設定する場合に便利です。たとえば PixelFormat を IC4_PIXEL_FORMAT_Mono8 に設定する場合などです。

パラメータ
[in]propEnumerationプロパティ
[in]entry_valueprop のenumeration entryの値です。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
関連項目
ic4_prop_enum_set_selected_entry
ic4_prop_enum_get_int_value

◆ ic4_prop_enum_set_selected_entry()

bool ic4_prop_enum_set_selected_entry ( struct IC4_PROPERTY *  prop,
struct IC4_PROPERTY *  entry 
)

列挙の選択エントリを設定します。

パラメータ
[in]propEnumerationプロパティ
[in]entryprop のenumeration entryです。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
entry がenumeration entryプロパティでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
entry が prop のenumeration entryでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_VALUE_ERROR に設定されます。
関連項目
ic4_prop_enum_set_value
ic4_prop_enum_set_int_value

◆ ic4_prop_enum_set_value()

bool ic4_prop_enum_set_value ( struct IC4_PROPERTY *  prop,
const char *  entry_name 
)

列挙の選択エントリを名前で設定します。

パラメータ
[in]propEnumerationプロパティ
[in]entry_nameprop のenumeration entryの名前です。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop がEnumeration Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
entry_name が prop のエントリの名前でない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_VALUE_ERROR に設定されます。
関連項目
ic4_prop_enum_set_selected_entry
ic4_prop_enum_set_int_value

◆ ic4_prop_enumentry_get_int_value()

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

enumeration entryの値を返します。

パラメータ
[in]prop列挙エントリ
[out]pValueenumeration entryの値を受け取る double へのポインタ
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
備考
prop が列挙エントリでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
関連項目
ic4_prop_enum_get_entries