microscope.cameras.pvcam.PVStringParam Class Reference

Inheritance diagram for microscope.cameras.pvcam.PVStringParam:

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)

Additional Inherited Members
Static Public Member Functions inherited from microscope.cameras.pvcam.PVParam
	factory (camera, param_id)
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
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 strings

Definition at line 1383 of file pvcam.py.

Member Function Documentation

current()

microscope.cameras.pvcam.PVStringParam.current

(

self

)

Return the current (or cached) string parameter value.

Reimplemented from microscope.cameras.pvcam.PVParam.

Definition at line 1393 of file pvcam.py.

    def current(self):
        """Return the current (or cached) string parameter value."""
        return self._query().decode()
 

set_value()

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

Set a string parameter value

Reimplemented from microscope.cameras.pvcam.PVParam.

Definition at line 1386 of file pvcam.py.

    def set_value(self, new_value):
        """Set a string parameter value"""
        if hasattr(new_value, "encode"):
            new_value = new_value.encode()
        super().set_value(new_value)
 

values()

microscope.cameras.pvcam.PVStringParam.values

(

self

)

Get allowable string length.

Reimplemented from microscope.cameras.pvcam.PVParam.

Definition at line 1398 of file pvcam.py.

    def values(self):
        """Get allowable string length."""
        values = _length_map[self.param_id] or 0
        return values
 
 

---

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

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