mecheye.shared.Parameter

class mecheye.shared.Parameter(*args, **kwargs)

A device parameter handle obtained from UserSet.get_parameter().

Direct construction is unavailable. Convert a generic handle with the desired typed subclass’s convert_from_parameter() method before reading or writing it.

name()

Return the device parameter’s SDK identifier.

type()

Return the Parameter._* type identifier.

description()

Return the SDK-provided description for this parameter.

is_writable()

Return whether the parameter is currently writable.

is_readable()

Return whether the parameter is currently readable.

classmethod convert_from_parameter(param)

Return a typed view when param has this subclass’s parameter kind.

Parameters:

param – A Parameter handle or None.

Returns:

A typed handle, or None if the handle is absent or its kind differs.

Raises:

TypeError – A non-Parameter value is supplied.

_Bool = 2

_Enum = 3

_Float = 1

_FloatArray = 6

_Int = 0

_ProfileRoi = 8

_Range = 5

_Roi = 4

_RoiArray = 7