Inheritance diagram for microscope.testsuite.test_devices.LightSourceTests:

Public Member Functions
def	assertEqualMW (self, first, second, msg=None)

def	test_get_is_on (self)

def	test_off_after_constructor (self)

def	test_turning_on_and_off (self)

def	test_shutdown (self)

def	test_power_when_off (self)

def	test_setting_power (self)

def	test_setting_power_outside_limit (self)

def	test_status (self)

Public Member Functions inherited from microscope.testsuite.test_devices.DeviceTests
def	test_on_and_off (self)

def	test_enable_and_disable (self)

def	test_enable_enabled (self)

def	test_disable_disabled (self)

Detailed Description

Base class for :class:`LightSource` tests.

This class implements all the general laser tests and is meant to
be mixed with :class:`unittest.TestCase`.  Subclasses must
implement the `setUp` method which must add two properties:

`device`
    Instance of the :class:`LightSource` implementation being
    tested.

`fake`
    Object with a multiple attributes that specify the hardware
    and control the tests, such as the device max and min power
    values.  Such attributes may as well be attributes in the
    class that fakes the hardware.

Definition at line 159 of file test_devices.py.

Member Function Documentation

◆ assertEqualMW()

def microscope.testsuite.test_devices.LightSourceTests.assertEqualMW	(	self,
		first,
		second,
		msg = `None`
	)

Definition at line 178 of file test_devices.py.

    def assertEqualMW(self, first, second, msg=None):
        # We could be smarter, but rounding the values should be
        # enough to check the values when comparing power levels.
        self.assertEqual(round(first), round(second), msg)
 

◆ test_get_is_on()

def microscope.testsuite.test_devices.LightSourceTests.test_get_is_on ( self )

Definition at line 183 of file test_devices.py.

    def test_get_is_on(self):
        self.assertEqual(self.device.connection.light, self.device.get_is_on())
        self.device.enable()
        self.assertEqual(self.device.connection.light, self.device.get_is_on())
        self.device.disable()
        self.assertEqual(self.device.connection.light, self.device.get_is_on())
 

◆ test_off_after_constructor()

def microscope.testsuite.test_devices.LightSourceTests.test_off_after_constructor ( self )

Definition at line 190 of file test_devices.py.

    def test_off_after_constructor(self):
        # Some lasers, such as our Coherent Sapphire emit laser
        # radiation as soon as the key is switched on.  We should
        # ensure that the laser is turned off during the
        # construction.
        self.assertFalse(self.device.get_is_on())
 

◆ test_power_when_off()

def microscope.testsuite.test_devices.LightSourceTests.test_power_when_off ( self )

Definition at line 208 of file test_devices.py.

    def test_power_when_off(self):
        self.device.disable()
        self.assertIsInstance(self.device.power, float)
        self.assertEqual(self.device.power, 0.0)
 

◆ test_setting_power()

def microscope.testsuite.test_devices.LightSourceTests.test_setting_power ( self )

Definition at line 213 of file test_devices.py.

    def test_setting_power(self):
        self.device.enable()
        self.assertIsInstance(self.device.power, float)
        power_mw = self.device.power * self.fake.max_power
        self.assertEqualMW(power_mw, self.fake.default_power)
        self.assertEqualMW(self.device.power, self.device.get_set_power())
 
        new_power = 0.5
        new_power_mw = new_power * self.fake.max_power
        self.device.power = new_power
        self.assertEqualMW(
            self.device.power * self.fake.max_power, new_power_mw
        )
        self.assertEqualMW(new_power, self.device.get_set_power())
 

◆ test_setting_power_outside_limit()

def microscope.testsuite.test_devices.LightSourceTests.test_setting_power_outside_limit ( self )

Definition at line 228 of file test_devices.py.

    def test_setting_power_outside_limit(self):
        self.device.enable()
        self.device.power = -0.1
        self.assertEqual(
            self.device.power,
            self.fake.min_power / self.fake.max_power,
            "clip setting power below 0",
        )
        self.device.power = 1.1
        self.assertEqual(self.device.power, 1.0, "clip setting power above 1")
 

◆ test_shutdown()

def microscope.testsuite.test_devices.LightSourceTests.test_shutdown ( self )

Definition at line 203 of file test_devices.py.

    def test_shutdown(self):
        self.device.enable()
        self.device.disable()
        self.device.shutdown()
 

◆ test_status()

def microscope.testsuite.test_devices.LightSourceTests.test_status ( self )

Definition at line 239 of file test_devices.py.

    def test_status(self):
        status = self.device.get_status()
        self.assertIsInstance(status, list)
        for msg in status:
            self.assertIsInstance(msg, str)
 
 

◆ test_turning_on_and_off()

def microscope.testsuite.test_devices.LightSourceTests.test_turning_on_and_off ( self )

Definition at line 197 of file test_devices.py.

    def test_turning_on_and_off(self):
        self.device.enable()
        self.assertTrue(self.device.get_is_on())
        self.device.disable()
        self.assertFalse(self.device.get_is_on())
 

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

F:/repos/BioImager/BioImager/PythonMicroscope/microscope/testsuite/test_devices.py

Public Member Functions