microscope.cameras.pvcam.PVEnumParam Class Reference

Inheritance diagram for microscope.cameras.pvcam.PVEnumParam:

Public Member Functions
	set_value (self, new_value)
	current (self)
	values (self)
Public Member Functions inherited from microscope.cameras.pvcam.PVParam
	__init__ (self, camera, param_id)
	access (self)
	available (self)
	count (self)

Public Attributes
	name
	count = {}
Public Attributes inherited from microscope.cameras.pvcam.PVParam
	cam = weakref.proxy(camera)
	param_id = param_id
str	name = _param_to_name[param_id]
	dtype = _dtypemap[self._pvtype]
	available

Additional Inherited Members
Static Public Member Functions inherited from microscope.cameras.pvcam.PVParam
	factory (camera, param_id)
Protected Member Functions inherited from microscope.cameras.pvcam.PVParam
	_query (self, what=ATTR_CURRENT, force_query=False)
Protected Attributes inherited from microscope.cameras.pvcam.PVParam
int	_pvtype = param_id >> 24 & 255
	_ctype = _typemap[self._pvtype]

Detailed Description

PVParam subclass for enums

Definition at line 1338 of file pvcam.py.

Member Function Documentation

current()

microscope.cameras.pvcam.PVEnumParam.current

(

self

)

Return the current (or cached) enum parameter value.

Reimplemented from microscope.cameras.pvcam.PVParam.

Definition at line 1365 of file pvcam.py.

    def current(self):
        """Return the current (or cached) enum parameter value."""
        # c_void_p(0) is None, so replace with 0
        return int(self._query() or 0)
 

set_value()

microscope.cameras.pvcam.PVEnumParam.set_value	(		self,
			new_value )

Set an enum parameter value.

Reimplemented from microscope.cameras.pvcam.PVParam.

Definition at line 1341 of file pvcam.py.

    def set_value(self, new_value):
        """Set an enum parameter value."""
        # We may be passed a value, a description string, or a tuple of
        # (value, string).
        values, descriptions = list(zip(*self.values.items()))
        if hasattr(new_value, "__iter__"):
            desc = str(new_value[1])
        elif isinstance(new_value, str):
            desc = str(new_value)
        else:
            desc = None
        # If we have a description, rely on that, as this avoids any confusion
        # of index and value.
        if desc and desc in descriptions:
            new_index = descriptions.index(desc)
            new_value = values[new_index]
        elif desc:
            raise Exception(
                "Could not find description '%s' for enum %s."
                % (desc, self.name)
            )
        super().set_value(new_value)
 

values()

microscope.cameras.pvcam.PVEnumParam.values

(

self

)

Get allowable enum values

Reimplemented from microscope.cameras.pvcam.PVParam.

Definition at line 1371 of file pvcam.py.

    def values(self):
        """Get allowable enum values"""
        values = {}
        for i in range(self.count):
            length = _enum_str_length(self.cam.handle, self.param_id, i)
            value, desc = _get_enum_param(
                self.cam.handle, self.param_id, i, length
            )
            values[value.value] = desc.value.decode()
        return values
 
 

Member Data Documentation

count

microscope.cameras.pvcam.PVEnumParam.count = {}

Definition at line 1374 of file pvcam.py.

name

microscope.cameras.pvcam.PVEnumParam.name

Definition at line 1360 of file pvcam.py.

---

The documentation for this class was generated from the following file:

• BioImager/PythonMicroscope/microscope/cameras/pvcam.py