LocalBlock

class pyrogue.LocalBlock(*, variable, localSet, localGet, minimum, maximum, value)

Back-end Block class used by LocalVariable.

Stores value in local memory.

Parameters:

• variable (LocalVariable) – Variable associated with this block.

• localSet (Callable[[Any, Device | None, BaseVariable | None, bool | None], Any] | None) – Setter callback. Expected signature: localSet(value, dev=None, var=None, changed=None).

• localGet (Callable[[Device | None, BaseVariable | None], Any] | None) – Getter callback. Expected signature: localGet(dev=None, var=None).

• minimum (Any | None) – Minimum allowed value (may be None).

• maximum (Any | None) – Maximum allowed value (may be None).

• value (Any) – Initial value stored in the block.

property path: str

Return the block path.

property mode: str

Return the variable access mode. (‘RW’, ‘RO’, etc).

property bulkOpEn: bool

Return True to enable bulk operations.

forceStale()

Mark the block as stale (no-op for local blocks).

Return type:

None

setEnable(value)

Enable or disable local access.

Parameters:

value (bool) – True to enable local access, False to disable.

Return type:

None

property variables: list

Return the list of variables in this block.

set(var, value, index=-1)

Set the block value, optionally for an index.

Parameters:

• var (LocalVariable) – Variable associated with this block.

• value (Any) – Value to write.

• index (int, default: -1) – Index for array variables.

Return type:

None

get(var, index=-1)

Get the block value, optionally for an index.

Parameters:

• var (LocalVariable) – Variable associated with this block.

• index (int, default: -1) – Index for array variables.

Returns:

Current value.

Return type:

Any