Source code for larpix.logger.logger

import warnings
warnings.simplefilter('default', DeprecationWarning)

class Logger(object):
    '''
    Base class for larpix logger objects that explicity describes the necessary
    functions for a Logger implementation. Additional functions are not built
    into the larpix core.

    '''

    #: Flag to indicate packets were sent to ASICs
    WRITE = 0
    #: Flag to indicate packets were received from ASICs
    READ = 1

    def __init__(self, enabled=False, *args, **kwargs):
        '''
        Create new logger instance.

        '''
        self._enabled = enabled
        self._open = False

    def record_configs(self, chips):
        '''
        Save specified chip configs to log file (if applicable)

        :param configs: list of Chips to log

        '''
        pass

    def record(self, data, direction=0, *args, **kwargs):
        '''
        Log specified data.

        :param data: ``list`` of data to be written to log. Valid data types are specified by logger implementation. Raises a ``ValueError`` if datatype is invalid.
        :param direction: ``Logger.WRITE`` if packets were sent to
            ASICs, ``Logger.READ`` if packets
            were received from ASICs. (default: ``Logger.WRITE``)

        '''
        pass

    def is_enabled(self):
        '''
        Check if logger is enabled, i.e. actively recording data.
        All data passed into ``record()`` between an ``enable()`` and
        ``disable()`` command should be reflected in the log.

        '''
        return self._enabled

    def enable(self):
        '''
        Enable logger

        '''
        self._enabled = True

    def disable(self):
        '''
        Disable logger

        .. note:: This flushes any data in the buffer before disabling

        '''
        if self._enabled:
            self.flush()
        self._enabled = False

    def flush(self):
        '''
        Flushes any held data from memory to the destination

        '''
        pass