GenICam GenApiクラス¶

PyIBoolean¶

class stapipy.PyIBoolean(PyNode node)¶

ベースクラス: stapipy.PyIValue

IBooleanインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

get_value(self, bool verify=False, bool ignore_cache=False) → bool¶

ノードの値を取得します。 verify か ignore_cache のうち少なくても一方の引数はTrueにしてください。両方の引数がFalse場合は、valueプロパティーを使用してください。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値

戻り値の型

bool

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

set_value(self, bool value, bool verify=True)¶

ノードの値を設定します。

パラメータ

value (bool) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

value¶

PyIBoolean.value: bool

プロパティー：現在のノード値

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。
戻り値の型: bool

PyICategory¶

class stapipy.PyICategory(PyNode node)¶

ベースクラス: stapipy.PyIValue

ICategoryインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

feature_list¶

PyICategory.feature_list: list

プロパティー：カテゴリ内の全フィーチャーが返されます。

Getter: フィーチャーノードのリストが返されます。
戻り値の型: list of PyNode

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

PyICommand¶

class stapipy.PyICommand(PyNode node)¶

ベースクラス: stapipy.PyIValue

ICommandインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

execute(self, bool verify=False)¶

コマンドノードを実行します。

パラメータ: verify (bool) -- ベリファイフラグ

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

is_done(self, bool verify=True) → bool¶

実行完了かどうかを確認します。

パラメータ: verify (bool) -- ベリファイフラグ
戻り値: 実行が完了したらTrueが返されます。
戻り値の型: bool

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

PyIEnumeration¶

class stapipy.PyIEnumeration(PyNode node)¶

ベースクラス: stapipy.PyIValue

IEnumerationインターフェイスにアクセスするためのクラス

列挙型エントリは、シンボリック値または数値のいずれかを介して反復可能です。

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

current_entry¶

PyIEnumeration.current_entry: PyNode

プロパティー：現在の列挙型のエントリ

Getter: 現在の列挙型のエントリのPyNodeが返されます。
戻り値の型: PyNode

entries¶

PyIEnumeration.entries: list

プロパティー：列挙型のエントリのリスト

Getter: 列挙型のエントリのPyNodeリストが返されます。
戻り値の型: list of PyNode

entries_count¶

PyIEnumeration.entries_count: int

プロパティー：列挙型のエントリ数

Getter: 戻り値が返されます。
戻り値の型: int

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

get_int_value(self, bool verify=False, bool ignore_cache=False) → int64_t¶

数字型の値を取得します。 verify か ignore_cache のうち少なくても一方の引数はTrueにしてください。両方の引数がFalse場合は、valueプロパティーを使用してください。

パラメータ

verify (bool) -- ベリファイフラグ
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（int型）

戻り値の型

int

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

set_entry_value(self, PyIEnumEntry enum_entry, bool verify=True)¶

エントリオブジェクトを使用して列挙の値を設定します。

パラメータ

enum_entry (PyIEnumEntry) -- 列挙型のエントリオブジェクト
verify (bool) -- ベリファイフラグ

set_int_value(self, int64_t value, bool verify=True)¶

数値を使用して列挙の値を設定します。

パラメータ

value (int) -- 数値
verify (bool) -- ベリファイフラグ

set_symbolic_value(self, unicode value, bool verify=True)¶

シンボリック値を使用して列挙値を設定します。

パラメータ

value (str) -- シンボリック値
verify (bool) -- ベリファイフラグ

symbolics_list¶

PyIEnumeration.symbolics_list: list

プロパティー：列挙型エントリのシンボリック値のリスト

Getter: リストが返されます。
戻り値の型: list of str

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

value¶

PyIEnumeration.value: int

プロパティー：現在の列挙の整数値

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。
戻り値の型: int

PyIEnumEntry¶

class stapipy.PyIEnumEntry(PyNode node)¶

ベースクラス: stapipy.PyIValue

IEnumEntryインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

is_self_clearing¶

PyIEnumEntry.is_self_clearing: bool

プロパティー：列挙型のエントリのセルフクリアフラグ

Getter: フラグが返されます。
戻り値の型: bool

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

numeric_value¶

PyIEnumEntry.numeric_value: float

プロパティー：この列挙型エントリのfloat値

Getter: 数値が返されます。
戻り値の型: float

symbolic_value¶

PyIEnumEntry.symbolic_value: str

プロパティー：この列挙型のエントリのシンボリック（str）型の値

Getter: シンボリック値が返されます。
戻り値の型: str

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

value¶

PyIEnumEntry.value: int

プロパティー：この列挙型エントリの整数値

Getter: 数値が返されます。
戻り値の型: int

PyIFloat¶

class stapipy.PyIFloat(PyNode node)¶

ベースクラス: stapipy.PyIValue

IFloatインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

display_notation¶

PyIFloat.display_notation: EGCDisplayNotation

プロパティー：文字列に変換する表示表記

Getter: 戻り値が返されます。
戻り値の型: EGCDisplayNotation

display_precision¶

PyIFloat.display_precision: int

プロパティー：文字列に変換するときの精度

Getter: 戻り値が返されます。
戻り値の型: int

enum_alias¶

PyIFloat.enum_alias: PyNode

プロパティー：列挙型インターフェイスを持つノードエイリアス

Getter: ノードエイリアスが返されます。
戻り値の型: PyNode or None

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

get_valid_values(self, bool bounded=True) → list¶

有効な値が定義されている場合は、その値を取得します。

パラメータ: bounded (bool) -- 制限付きフラグ
戻り値: 有効な値のリストが返されます。
戻り値の型: list of float

get_value(self, bool verify=False, bool ignore_cache=False) → double¶

ノードの値を取得します。 verify か ignore_cache のうち少なくても一方の引数はTrueにしてください。両方の引数がFalse場合は、valueプロパティーを使用してください。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値

戻り値の型

float

has_inc¶

PyIFloat.has_inc: bool

プロパティー：このノードが一定の増分を持つかどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

inc¶

PyIFloat.inc: float

プロパティー：一定の増分

Getter: 戻り値が返されます。
戻り値の型: float

inc_mode¶

PyIFloat.inc_mode: EGCIncMode

プロパティー：インクリメントモード

Getter: 戻り値が返されます。
戻り値の型: EGCIncMode

int_alias¶

PyIFloat.int_alias: PyNode

プロパティー：整数インターフェイスを持つノードエイリアス

Getter: 整数インターフェイスを持つノードエイリアスが返されます。
戻り値の型: PyNode or None

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

max¶

PyIFloat.max: float

プロパティー：最大許容値

Getter: 戻り値が返されます。
Setter: 値を設定します。
戻り値の型: float

min¶

PyIFloat.min: float

プロパティー：最小許容値

Getter: 戻り値が返されます。
Setter: 値を設定します。
戻り値の型: float

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

representation¶

PyIFloat.representation: EGCRepresentation

プロパティー：ノードの推奨表現

Getter: 戻り値が返されます。
戻り値の型: EGCRepresentation

set_value(self, double value, bool verify=True)¶

ノードの値を設定します。

パラメータ

value (float) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

unit¶

PyIFloat.unit: str

プロパティー：単位名

Getter: 戻り値が返されます。
戻り値の型: str

value¶

PyIFloat.value: float

プロパティー：現在のノード値

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。
戻り値の型: float

PyIInteger¶

class stapipy.PyIInteger(PyNode node)¶

ベースクラス: stapipy.PyIValue

IIntegerインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

float_alias¶

PyIInteger.float_alias: PyNode

プロパティー：floatインターフェイスを持つノードエイリアス

Getter: floatインターフェイスを持つノードが返されます。
戻り値の型: PyNode or None

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

get_valid_values(self, bool bounded=True) → list¶

有効な値が定義されている場合は、その値を取得します。

パラメータ: bounded (bool) -- 制限付きフラグ
戻り値: 有効な値のリストが返されます。
戻り値の型: list of int

get_value(self, bool verify=False, bool ignore_cache=False) → int64_t¶

ノードの値を取得します。 verify か ignore_cache のうち少なくても一方の引数はTrueにしてください。両方の引数がFalse場合は、valueプロパティーを使用してください。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値

戻り値の型

int

inc¶

PyIInteger.inc: int

プロパティー：一定の増分

Getter: 戻り値が返されます。
戻り値の型: int

inc_mode¶

PyIInteger.inc_mode: EGCIncMode

プロパティー：インクリメントモード

Getter: 戻り値が返されます。
戻り値の型: EGCIncMode

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

max¶

PyIInteger.max: int

プロパティー：最大許容値

Getter: 戻り値が返されます。
Setter: 値を設定します。
戻り値の型: int

min¶

PyIInteger.min: int

プロパティー：最小許容値

Getter: 戻り値が返されます。
Setter: 値を設定します。
戻り値の型: int

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

representation¶

PyIInteger.representation: EGCRepresentation

プロパティー：ノードの推奨表現

Getter: 戻り値が返されます。
戻り値の型: EGCRepresentation

set_value(self, int64_t value, bool verify=True)¶

ノードの値を設定します。

パラメータ

value (int) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

unit¶

PyIInteger.unit: str

プロパティー：単位名

Getter: 戻り値が返されます。
戻り値の型: str

value¶

PyIInteger.value: int

プロパティー：現在のノード値

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。
戻り値の型: int

PyIRegister¶

class stapipy.PyIRegister(PyNode node)¶

ベースクラス: stapipy.PyIValue

IRegisterインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

address¶

PyIRegister.address: int

プロパティー：レジスタアドレス

Getter: 戻り値が返されます。
戻り値の型: int

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

get_address(self, bool verify=False) → int64_t¶

レジスタアドレスを取得します。

パラメータ: verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
戻り値: レジスタアドレス
戻り値の型: int

get_length(self, bool verify=False) → int64_t¶

レジスタデータのサイズを取得します。

パラメータ: verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
戻り値: レジスタデータのサイズ
戻り値の型: int

get_value(self, bool verify=False, bool ignore_cache=False) → bytes¶

ノードの値を取得します。 verify か ignore_cache のうち少なくても一方の引数はTrueにしてください。両方の引数がFalse場合は、valueプロパティーを使用してください。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値

戻り値の型

bytes

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

length¶

PyIRegister.length: int

プロパティー：レジスタデータのサイズ

Getter: 戻り値が返されます。
戻り値の型: int

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

set_value(self, bytes buffer, bool verify=True)¶

ノードの値を設定します。

パラメータ

buffer (bytes) -- 設定するデータ
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

value¶

PyIRegister.value: bytes

プロパティー：現在のノード値

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。
戻り値の型: bytes

PyIString¶

class stapipy.PyIString(PyNode node)¶

ベースクラス: stapipy.PyIValue

IStringインターフェイスにアクセスするためのクラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

get_max_length(self, bool verify=False) → int64_t¶

文字列の最大サイズを取得します。

パラメータ: verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
戻り値: 文字列の最大サイズ
戻り値の型: int

get_value(self, bool verify=False, bool ignore_cache=False) → unicode¶

ノードの値を取得します。 verify か ignore_cache のうち少なくても一方の引数はTrueにしてください。両方の引数がFalse場合は、valueプロパティーを使用してください。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値

戻り値の型

str

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

max_length¶

PyIString.max_length: int

プロパティー：文字列の最大サイズ

Getter: 文字列の最大サイズが返されます。
戻り値の型: int

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

set_value(self, unicode value, bool verify=True)¶

ノードの値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

value¶

PyIString.value: str

プロパティー：現在のノード値

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。
戻り値の型: str

PyIValue¶

class stapipy.PyIValue¶

ベースクラス: object

インターフェイスクラスの基本クラス

access_mode¶

PyIValue.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

from_string(self, unicode value, bool verify=True)¶

str型の値を設定します。

パラメータ

value (str) -- 設定する値
verify (bool) -- ノード値を書き込んだ後にベリファイを実行するかどうかを示すフラグ（デフォルトはTrue）

is_value_cache_valid¶

PyIValue.is_value_cache_valid: bool

プロパティー：キャッシュが有効かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

node¶

PyIValue.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

to_string(self, bool verify=False, bool ignore_cache=False) → unicode¶

str型の値を取得します。

パラメータ

verify (bool) -- ノード値を読込むの際、ベリファイを実行するかどうかを示すフラグ（デフォルトはFalse）
ignore_cache (bool) -- キャッシュを無視するフラグ

戻り値

現在のノード値（str型）

戻り値の型

str

PyIPort¶

class stapipy.PyIPort(PyNode node)¶

ベースクラス: object

IPortインターフェイスにアクセスするためのクラス

node¶

PyIPort.node: PyNode

プロパティー：インターフェイスと関係ないノード

Getter: ノードが返されます。
戻り値の型: PyNode

read(self, int64_t address, int64_t length) → bytes¶

指定したアドレスから指定したバイト数のデータを読み込みます。

パラメータ

address (int) -- アクセスするアドレスを指定します。4の倍数である必要あり。
length (int) -- 読み込むデータのバイト数。4の倍数である必要あり。

戻り値

現在の値

戻り値の型

bytes

write(self, buffer, int64_t address, int64_t length=0)¶

指定したアドレスに指定したバイト数のデータを書き込みます。

パラメータ

buffer (bytes or bytearray) -- 書き込むデータ。長さは4の倍数である必要あり。
address (int) -- アクセスするアドレスを指定します。4の倍数である必要あり。
length (int) -- 書き込むデータのバイト数。4の倍数である必要あり。

PyNodeMap¶

class stapipy.PyNodeMap¶

ベースクラス: object

GenApiノードマップクラス

device_name¶

PyNodeMap.device_name: str

プロパティー：デバイス名

Getter: 戻り値が返されます。
戻り値の型: str

get_node(self, unicode node_name)¶

指定したノード名に対するノードを取得します。

パラメータ: node_name (str) -- ノード名
戻り値: ノード。存在しない場合はNone
戻り値の型: PyNode or None

get_nodes_name(self, bool full_qualified=False) → list¶

全ノード名を取得します。

パラメータ: full_qualified (bool) -- fully qualified nameかどうかを示すフラグ
戻り値: ノード名のリスト
戻り値の型: list of str

invalidate_nodes(self)¶: 全ノードの値を無効化(invalidate)にします。

lock¶

PyNodeMap.lock: PyLock

プロパティー：ノードマップガードのロック

Getter: ロックが返されます。
戻り値の型: PyLock

nodes_count¶

PyNodeMap.nodes_count: int

プロパティー：ノード数

Getter: 戻り値が返されます。
戻り値の型: int

poll(self, int elapsed_time)¶

ポーリングタイムがあるノードを更新します。

パラメータ: elapsed_time (int) -- 経過時間

set_suppress_callback_mode(self, suppress_mode)¶

コールバック抑制モードを設定します。

パラメータ: suppress_mode (EGCCallbackSuppressMode) -- コールバック抑制モード

PyNode¶

class stapipy.PyNode¶

ベースクラス: object

GenApiノードクラス

access_mode¶

PyNode.access_mode: EGCAccessMode

プロパティー：アクセスモード

Getter: 戻り値が返されます。
戻り値の型: EGCAccessMode

access_mode_cacheable¶

PyNode.access_mode_cacheable: EGCYesNo

プロパティー：アクセスモードがキャッシュ可能かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: EGCYesNo

alias¶

PyNode.alias: PyNode

プロパティー：ノードエイリアス

Getter: 戻り値が返されます。
戻り値の型: PyNode or None

caching_mode¶

PyNode.caching_mode: EGCCachingMode

プロパティー：ノードのキャッシュモード

Getter: 戻り値が返されます。
戻り値の型: EGCCachingMode

cast_alias¶

PyNode.cast_alias: PyNode

プロパティー：ノードキャストエイリアス

Getter: 戻り値が返されます。
戻り値の型: PyNode or None

children_name¶

PyNode.children_name: list

プロパティー：子ノード名のリスト

Getter: リストが返されます。
戻り値の型: list of str

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)¶

全てのコールバック登録を解除します。

パラメータ

registered_cb (PyStRegisteredCallback) -- 登録されたコールバック
check_all (bool) -- このPyNodeのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

deregister_callbacks(self, check_all=False)¶

全てのコールバック登録を解除します。

パラメータ: check_all (bool) -- このPyNodeのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

description¶

PyNode.description: str

プロパティー：ノードの詳細説明

Getter: 戻り値が返されます。
戻り値の型: str

device_name¶

PyNode.device_name: str

プロパティー：デバイス名

Getter: 戻り値が返されます。
戻り値の型: str

display_name¶

PyNode.display_name: str

プロパティー：表示名

Getter: 戻り値が返されます。
戻り値の型: str

docu_url¶

PyNode.docu_url: str

プロパティー：このノードのドキュメントを指すURL

Getter: 戻り値が返されます。
戻り値の型: str

event_id¶

PyNode.event_id: str

プロパティー：このノードのイベントID

Getter: 戻り値が返されます。
戻り値の型: str

get(self)¶

インターフェイス型に適したクラスのインスタンスを返します。

戻り値の型: PyIBoolean or PyICommand or PyIEnumEntry or PyIEnumeration or PyIFloat or PyIInteger or PyIRegister or PyICategory or PyIString

get_children(self, link_type=EGCLinkType.ReadingChildren) → list¶

子ノードのリストを取得します。

パラメータ: link_type (EGCLinkType) -- ノードリンクタイプ
戻り値: 子ノードのリスト
戻り値の型: list of PyNode

get_nodemap(self) → PyNodeMap¶

ノードマップを取得します。

戻り値: ノードマップ
戻り値の型: PyNodeMap

get_parents(self) → list¶

親ノードのリストを取得します。

戻り値: 親ノードのリスト
戻り値の型: list of PyNode

get_property(self, unicode property_name) → tuple¶

プロパティーの値と属性を取得します。

パラメータ: property_name (str) -- プロパティー名
戻り値: Tuple型でプロパティー値と属性が返されます。
戻り値の型: tuple (str, str)

get_registered_callbacks(self, check_all=False) → list¶

登録されたコールバックを取得します。

パラメータ: check_all (bool) -- このPyNodeのコピーモジュールを含む、登録されたコールバックを取得するフラグ
戻り値: PyStRegisteredCallbackのリストまたはNone
戻り値の型: list of PyStRegisteredCallback

impose_access_mode(self, access_mode)¶

このノードのアクセスモードを設定します。

パラメータ: access_mode (EGCAccessMode) -- 設定するアクセスモード

invalidate_node(self)¶: ノードの値を無効化(Invalidate)にします。

is_available¶

PyNode.is_available: bool

プロパティー：ノードアクセス可能かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

is_cachable¶

PyNode.is_cachable: bool

プロパティー：ノードがキャッシュ可能かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

is_deprecated¶

PyNode.is_deprecated: bool

プロパティー：このノードが廃止予定かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

is_feature¶

PyNode.is_feature: bool

プロパティー： Root カテゴリノードからこのノードをアクセスできるかどうかを示すフラグ

Getter: フラグが返されます。
戻り値の型: bool

is_implemented¶

PyNode.is_implemented: bool

プロパティー：ノードが実施されるかどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

is_readable¶

PyNode.is_readable: bool

プロパティー：ノード値が読み込み可能かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

is_streamable¶

PyNode.is_streamable: bool

プロパティー：ノード値が保存可能かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

is_writable¶

PyNode.is_writable: bool

プロパティー：ノード値が書き込み可能かどうかを示すフラグ

Getter: 戻り値が返されます。
戻り値の型: bool

name¶

PyNode.name: str

プロパティー：ノード名

Getter: 戻り値が返されます。
戻り値の型: str

name_full¶

PyNode.name_full: str

プロパティー：ノードのフルネーム

Getter: 戻り値が返されます。
戻り値の型: str

namespace¶

PyNode.namespace: EGCNamespace

プロパティー：ノードのネームスペース

Getter: 戻り値が返されます。
戻り値の型: EGCNamespace

parents_name¶

PyNode.parents_name: list

プロパティー：親ノード名のリスト

Getter: リストが返されます。
戻り値の型: list of str

polling_time¶

PyNode.polling_time: int

プロパティー：キャッシュ不可能なノードの推奨されるポーリング時間

Getter: 戻り値が返されます。
戻り値の型: int

principal_interface_type¶

PyNode.principal_interface_type: EGCInterfaceType

プロパティー：このノード値のインターフェイスタイプ

Getter: 戻り値が返されます。
戻り値の型: EGCInterfaceType

property_names¶

PyNode.property_names: list

プロパティー：このノードのプロパティー名のリスト

Getter: リストが返されます。
戻り値の型: list of str

register_callback(self, callback_func, user_data=None, callback_type=EGCCallbackType.InsideLock) → PyStRegisteredCallback¶

このノードにコールバック関数を登録します。

パラメータ

callback_func -- トリガーされる関数
user_data -- ユーザデータ（オプショナル）
callback_type (EGCCallbackType) -- コールバックタイプ

戻り値

登録されたコールバックのオブジェクト

戻り値の型

PyStRegisteredCallback

tooltip¶

PyNode.tooltip: str

プロパティー：ノードのツールチップ

Getter: 戻り値が返されます。
戻り値の型: str

value¶

プロパティー：ノードの値。返すデータタイプはインタフェイスタイプにより異なります。列挙型の場合は、数値が返されます。

Getter: 値が返されます。ベリファイとキャッシュ無視のフラグがFalse状態で値の読み込みを行います。
Setter: 値を設定します。書き込みの際、ベリファイフラグがTrueとなります。

visibility¶

PyNode.visibility: EGCVisibility

プロパティー：ノードの可視性

Getter: 戻り値が返されます。
Setter: 値を設定します。
戻り値の型: EGCVisibility

PyLock¶

class stapipy.PyLock¶

ベースクラス: object

GenApiロック処理クラス

lock(self)¶: 施錠します。

try_lock(self)¶: 施錠してみます。

unlock(self)¶: 開錠します。

GenICam GenApiクラス¶

PyIBoolean¶

PyICategory¶

PyICommand¶

PyIEnumeration¶

PyIEnumEntry¶

PyIFloat¶

PyIInteger¶

PyIRegister¶

PyIString¶

PyIValue¶

PyIPort¶

PyNodeMap¶

PyNode¶

PyLock¶

目次

前のトピックへ

次のトピックへ