microscope.cameras.pvcam.dllFunction Class Reference

Public Member Functions
	__init__ (self, name, args=[], argnames=[], buf_len=-1, lib=_lib)
	__call__ (self, *args, **kwargs)

Public Attributes
	f = getattr(lib, name)
	fargs = args
	fargnames = argnames
str	name = name
list	inp = [not isinstance(a, OUTPUT) for a in args]
list	in_args = [a for a in args if not isinstance(a, OUTPUT)]
list	out_args = [a for a in args if isinstance(a, OUTPUT)]
	buf_len = buf_len

Detailed Description

Expose a DLL function to python.

(Again, largely nicked from PYME.)

Definition at line 733 of file pvcam.py.

Constructor & Destructor Documentation

__init__()

microscope.cameras.pvcam.dllFunction.__init__	(		self,
			name,
			args = [],
			argnames = [],
			buf_len = -1,
			lib = _lib )

Definition at line 738 of file pvcam.py.

    def __init__(self, name, args=[], argnames=[], buf_len=-1, lib=_lib):
        self.f = getattr(lib, name)
        self.f.restype = rs_bool
        self.f.argtypes = [stripMeta(a) for a in args]
 
        self.fargs = args
        self.fargnames = argnames
        self.name = name
 
        self.inp = [not isinstance(a, OUTPUT) for a in args]
        self.in_args = [a for a in args if not isinstance(a, OUTPUT)]
        self.out_args = [a for a in args if isinstance(a, OUTPUT)]
 
        self.buf_len = buf_len
 
        docstring = name + "\n\nArguments:\n===========\n"
        for i in range(len(args)):
            an = ""
            if i < len(argnames):
                an = argnames[i]
            docstring += "\t%s\t%s\n" % (args[i], an)
 
        self.f.__doc__ = docstring
 

Member Function Documentation

__call__()

microscope.cameras.pvcam.dllFunction.__call__	(		self,
		*	args,
		**	kwargs )

Definition at line 762 of file pvcam.py.

    def __call__(self, *args, **kwargs):
        ars = []
        i = 0
        ret = []
        # pl_get_param buffer length depends on the parameter being fetched, so
        # use kwargs to pass buffer length.
        if "buf_len" in kwargs:
            bs = kwargs["buf_len"]
        elif self.name == "pl_get_enum_param":
            # last argument is buffer length
            bs = args[-1]
        elif self.buf_len >= 0:
            bs = self.buf_len
        else:
            bs = 256
        # May have been passed a ctype; if so, fetch its value.
        if isinstance(bs, ctypes._SimpleCData):
            bs = bs.value
 
        for j in range(len(self.inp)):
            if self.inp[j]:  # an input
                if self.f.argtypes[j] is CALLBACK and not isinstance(
                    args[i], CALLBACK
                ):
                    ars.append(CALLBACK(args[i]))
                else:
                    ars.append(args[i])
                i += 1
            else:  # an output
                r, ar = self.fargs[j].get_var(bs)
                ars.append(ar)
                ret.append(r)
                # print r, r._type_
 
        # print (self.name, ars)
        res = self.f(*ars)
        # print res
 
        if res == False:
            err_code = _lib.pl_error_code()
            err_msg = ctypes.create_string_buffer(ERROR_MSG_LEN)
            _lib.pl_error_message(err_code, err_msg)
            raise microscope.DeviceError(
                "pvcam error %d: %s" % (err_code, err_msg.value)
            )
 
        if len(ret) == 0:
            return None
        if len(ret) == 1:
            return ret[0]
        else:
            return ret
 
 

Member Data Documentation

buf_len

microscope.cameras.pvcam.dllFunction.buf_len = buf_len

Definition at line 751 of file pvcam.py.

f

microscope.cameras.pvcam.dllFunction.f = getattr(lib, name)

Definition at line 739 of file pvcam.py.

fargnames

microscope.cameras.pvcam.dllFunction.fargnames = argnames

Definition at line 744 of file pvcam.py.

fargs

microscope.cameras.pvcam.dllFunction.fargs = args

Definition at line 743 of file pvcam.py.

in_args

list microscope.cameras.pvcam.dllFunction.in_args = [a for a in args if not isinstance(a, OUTPUT)]

Definition at line 748 of file pvcam.py.

inp

microscope.cameras.pvcam.dllFunction.inp = [not isinstance(a, OUTPUT) for a in args]

Definition at line 747 of file pvcam.py.

name

str microscope.cameras.pvcam.dllFunction.name = name

Definition at line 745 of file pvcam.py.

out_args

list microscope.cameras.pvcam.dllFunction.out_args = [a for a in args if isinstance(a, OUTPUT)]

Definition at line 749 of file pvcam.py.

---

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

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