microscope.cameras.atmcd.dllFunction Class Reference

Public Member Functions
	__init__ (self, name, args=[], argnames=[], rstatus=False, lib=_dll)
	__call__ (self, *args)

Public Attributes
	f = getattr(lib, name)
	fargs = args
	fargnames = argnames
	name = name
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)]
	rstatus = rstatus
int	buf_size_arg_pos = -1
int	arr_size_arg_pos = -1
	arr_size_pos = i

Detailed Description

A wrapper class for DLL functions to make them available in python.

Definition at line 624 of file atmcd.py.

Constructor & Destructor Documentation

__init__()

microscope.cameras.atmcd.dllFunction.__init__	(		self,
			name,
			args = [],
			argnames = [],
			rstatus = False,
			lib = _dll )

Definition at line 627 of file atmcd.py.

    def __init__(self, name, args=[], argnames=[], rstatus=False, lib=_dll):
        # the library function
        self.f = getattr(lib, name)
        # dll call return type
        self.f.restype = c_uint
        # dll call parameter types
        self.f.argtypes = [stripMeta(a) for a in args]
        # dll call parameters, with their meta wrappers
        self.fargs = args
        # dll call parameter names, used to generate helpstrings
        self.fargnames = argnames
        # the function name
        self.name = name
        # input arguments
        self.in_args = [a for a in args if not isinstance(a, OUTPUT)]
        # output arguments
        self.out_args = [a for a in args if isinstance(a, OUTPUT)]
        # Indicates that this function should return the status code it generates.
        self.rstatus = rstatus
        # Find any arguments that set string buffer or array sizes.
        self.buf_size_arg_pos = -1
        self.arr_size_arg_pos = -1
        for i in range(len(self.in_args)):
            if isinstance(self.in_args[i], _OUTSTRLEN):
                self.buf_size_arg_pos = i
            if isinstance(self.in_args[i], _OUTARRSIZE):
                self.arr_size_pos = i
        # Generate a docstring.
        ds = name + "\n\nArguments:\n===========\n"
        for i in range(len(args)):
            an = ""
            if i < len(argnames):
                an = argnames[i]
            ds += "\t%s\t%s\n" % (args[i], an)
        self.f.__doc__ = ds
 

Member Function Documentation

__call__()

microscope.cameras.atmcd.dllFunction.__call__	(		self,
		*	args )

Parse arguments, allocate any required storage, and execute the call.

Definition at line 663 of file atmcd.py.

    def __call__(self, *args):
        """Parse arguments, allocate any required storage, and execute the call."""
        # The C function arguments
        c_args = []
        i = 0
        ret = []
 
        if self.buf_size_arg_pos >= 0:
            try:
                bs = args[self.buf_size_arg_pos]
            except:
                bs = 255
        else:
            bs = 255
        # Sort input and output arguments, allocating output storage as required.
        i = 0
        for farg in self.fargs:
            if isinstance(farg, OUTPUT):
                if isinstance(farg, OUTARR):
                    size = args[self.arr_size_arg_pos]
                else:
                    size = bs
                r, c_arg = farg.getVar(size)
                c_args.append(c_arg)
                ret.append(r)
            elif isinstance(farg, _OUTSTRLEN):
                c_args.append(bs)
            elif isinstance(args[i], Enum):
                c_args.append(args[i].value)
                i += 1
            else:
                c_args.append(args[i])
                i += 1
 
        # Make the library call, tolerating a few DRV_ERROR_ACKs
        status = DRV_ERROR_ACK
        ack_err_count = -1
        while status == DRV_ERROR_ACK and ack_err_count < 3:
            ack_err_count += 1
            status = self.f(*c_args)
        ret = [extract_value(r) for r in ret]
        if len(ret) == 1:
            ret = ret[0]
        elif len(ret) == 0:
            ret = None
        # A few functions indicate state using the returned status code instead
        # of filling a variable passed by reference pointer.
        if self.rstatus:
            if status == DRV_SUCCESS:
                return True
            elif status in [
                DRV_INVALID_AMPLIFIER,
                DRV_INVALID_MODE,
                DRV_INVALID_COUNTCONVERT_MODE,
                DRV_INVALID_FILTER,
            ]:
                return False
            elif status in [
                DRV_TEMP_OFF,
                DRV_TEMP_STABILIZED,
                DRV_TEMP_NOT_REACHED,
                DRV_TEMP_DRIFT,
                DRV_TEMP_NOT_STABILIZED,
            ]:
                return (status, ret)
            else:
                raise AtmcdException(status)
        # Most functions return values via pointers, or have no return.
        if not status == DRV_SUCCESS:
            raise AtmcdException(status)
        return ret
 
 

Member Data Documentation

arr_size_arg_pos

int microscope.cameras.atmcd.dllFunction.arr_size_arg_pos = -1

Definition at line 648 of file atmcd.py.

arr_size_pos

microscope.cameras.atmcd.dllFunction.arr_size_pos = i

Definition at line 653 of file atmcd.py.

buf_size_arg_pos

int microscope.cameras.atmcd.dllFunction.buf_size_arg_pos = -1

Definition at line 647 of file atmcd.py.

f

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

Definition at line 629 of file atmcd.py.

fargnames

microscope.cameras.atmcd.dllFunction.fargnames = argnames

Definition at line 637 of file atmcd.py.

fargs

microscope.cameras.atmcd.dllFunction.fargs = args

Definition at line 635 of file atmcd.py.

in_args

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

Definition at line 641 of file atmcd.py.

name

microscope.cameras.atmcd.dllFunction.name = name

Definition at line 639 of file atmcd.py.

out_args

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

Definition at line 643 of file atmcd.py.

rstatus

microscope.cameras.atmcd.dllFunction.rstatus = rstatus

Definition at line 645 of file atmcd.py.

---

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

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