microscope.testsuite.mock_devices.SerialMock Class Reference

Inheritance diagram for microscope.testsuite.mock_devices.SerialMock:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	open (self)
def	close (self)
def	handle (self, command)
def	write (self, data)
def	read (self, size=1)
def	readline (self, size=-1)
def	reset_input_buffer (self)
def	reset_output_buffer (self)

Public Attributes
	in_buffer
	out_buffer
	out_pending_bytes
	out_parsed_bytes
	in_read_bytes

Detailed Description

Base class to mock devices controlled via serial.

It has two :class:`io.BytesIO` buffers.  One :func:`write`s the
output buffer and the other :func:`read`s the input buffer.  After
a write, the output buffer is analysed for a command.  If there is
a command, stuff gets done.  This usually means adding to the
input buffer and changing state of the device.

Definition at line 38 of file mock_devices.py.

Constructor & Destructor Documentation

__init__()

def microscope.testsuite.mock_devices.SerialMock.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 49 of file mock_devices.py.

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.in_buffer = io.BytesIO()
        self.out_buffer = io.BytesIO()
 
        # Number of bytes in out buffer pending 'interpretation'.  A
        # command is only interpreted and handled when EOL is seen.
        self.out_pending_bytes = 0
        self.out_parsed_bytes = 0
 
        # Number of bytes in the input buffer that have been read
        self.in_read_bytes = 0
 

Member Function Documentation

close()

def microscope.testsuite.mock_devices.SerialMock.close

(

self

)

Definition at line 65 of file mock_devices.py.

    def close(self):
        self.in_buffer.close()
        self.out_buffer.close()
 

handle()

def microscope.testsuite.mock_devices.SerialMock.handle	(		self,
			command
	)

Definition at line 69 of file mock_devices.py.

    def handle(self, command):
        raise NotImplementedError("sub classes need to implement handle()")
 

Referenced by microscope.cameras._SDK3Cam.SDK3Camera.__init__(), microscope.cameras.pvcam.PVCamera.abort(), microscope.cameras.andorsdk3.AndorSDK3.get_id(), microscope.cameras.andorsdk3.AndorSDK3.initialize(), microscope.cameras.pvcam.PVCamera.initialize(), microscope.cameras.andorsdk3.AndorSDK3.invalidate_buffers(), microscope.cameras.pvcam.PVCamera.set_trigger(), and microscope.cameras.pvcam.PVCamera.soft_trigger().

open()

def microscope.testsuite.mock_devices.SerialMock.open

(

self

)

Definition at line 62 of file mock_devices.py.

    def open(self):
        pass
 

read()

def microscope.testsuite.mock_devices.SerialMock.read	(		self,
			size = 1
	)

Definition at line 93 of file mock_devices.py.

    def read(self, size=1):
        return self._readx_wrapper(self.in_buffer.read, size)
 

readline()

def microscope.testsuite.mock_devices.SerialMock.readline	(		self,
			size = -1
	)

Definition at line 96 of file mock_devices.py.

    def readline(self, size=-1):
        return self._readx_wrapper(self.in_buffer.readline, size)
 

Referenced by microscope.controllers.prior._ProScanIIIConnection.get_command(), microscope.stages.ludl._LudlController.get_command(), and microscope.stages.ludl._LudlController.readline().

reset_input_buffer()

def microscope.testsuite.mock_devices.SerialMock.reset_input_buffer

(

self

)

Definition at line 99 of file mock_devices.py.

    def reset_input_buffer(self):
        self.in_read_bytes = self.in_buffer.getbuffer().nbytes
        self.in_buffer.seek(0, 2)
 

reset_output_buffer()

def microscope.testsuite.mock_devices.SerialMock.reset_output_buffer

(

self

)

Definition at line 103 of file mock_devices.py.

    def reset_output_buffer(self):
        pass
 
 

write()

def microscope.testsuite.mock_devices.SerialMock.write	(		self,
			data
	)

Definition at line 72 of file mock_devices.py.

    def write(self, data):
        self.out_buffer.write(data)
        self.out_pending_bytes += len(data)
 
        if self.out_pending_bytes > len(data):
            # we need to retrieve data from a previous write
            self.out_buffer.seek(-self.out_pending_bytes, 2)
            data = self.out_buffer.read(self.out_pending_bytes)
 
        for msg in data.split(self.eol)[:-1]:
            self.handle(msg)
            self.out_pending_bytes -= len(msg) + len(self.eol)
        return len(data)
 

Member Data Documentation

in_buffer

microscope.testsuite.mock_devices.SerialMock.in_buffer

Definition at line 51 of file mock_devices.py.

in_read_bytes

microscope.testsuite.mock_devices.SerialMock.in_read_bytes

Definition at line 60 of file mock_devices.py.

out_buffer

microscope.testsuite.mock_devices.SerialMock.out_buffer

Definition at line 52 of file mock_devices.py.

out_parsed_bytes

microscope.testsuite.mock_devices.SerialMock.out_parsed_bytes

Definition at line 57 of file mock_devices.py.

out_pending_bytes

microscope.testsuite.mock_devices.SerialMock.out_pending_bytes

Definition at line 56 of file mock_devices.py.

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/testsuite/mock_devices.py