VectorVariable Class Reference

Inheritance diagram for VectorVariable:

Public Member Functions
def	format_value (self, value, check=True)

Protected Member Functions
def	_format_value (self, value, size, check)

Static Private Attributes
tuple	__slots__ = ()
	variables

Detailed Description

Bit vector variable type.

This is for the various non-scalar and non-real variable types including
integer, register, wire, etc.

Definition at line 537 of file writer.py.

Member Function Documentation

_format_value()

def _format_value (   self,   value,   size,   check  )

protected

format value function of VCDWriter

Definition at line 594 of file writer.py.

    def _format_value(self, value, size, check):
        """format value function of VCDWriter"""
        if isinstance(value, int):
            max_val = 1 << size
            if check and (-value > (max_val >> 1) or value >= max_val):
                raise ValueError(f'Value ({value}) not representable in {size} bits')
            if value < 0:
                value += max_val
            return format(value, 'b')
        elif value is None:
            return 'z'
        else:
            if check and (not isinstance(value, str) or
                          len(value) > size or
                          any(c not in '01xzXZ-' for c in value)):
                raise ValueError(f'Invalid vector value ({value})')
            return value

format_value()

def format_value	(		self,
			value,
			check = True
	)

Format value change for VCD stream.

:param value: New value for the variable.
:types value: int, str, or None
:raises ValueError: for *some* invalid values.

A *value* of `None` is the same as `'z'`.

.. Warning::

    If *value* is of type :py:class:`str`, all characters must be one
    of `'01xzXZ'`. For the sake of performance, checking **is not**
    done to ensure value strings only contain conforming characters.
    Thus it is possible to produce invalid VCD streams with invalid
    string values.

Reimplemented from Variable.

Definition at line 548 of file writer.py.

    def format_value(self, value, check=True):
        """Format value change for VCD stream.
 
        :param value: New value for the variable.
        :types value: int, str, or None
        :raises ValueError: for *some* invalid values.
 
        A *value* of `None` is the same as `'z'`.
 
        .. Warning::
 
            If *value* is of type :py:class:`str`, all characters must be one
            of `'01xzXZ'`. For the sake of performance, checking **is not**
            done to ensure value strings only contain conforming characters.
            Thus it is possible to produce invalid VCD streams with invalid
            string values.
 
        """
        if isinstance(self.size, tuple):
            # The string is built-up right-to-left in order to minimize/avoid
            # left-extension in the final value string.
            vstr_list = []
            vstr_len = 0
            size_sum = 0
            for i, (v, size) in enumerate(zip(reversed(value),
                                              reversed(self.size))):
                vstr = self._format_value(v, size, check)
                if not vstr_list:
                    vstr_list.insert(0, vstr)
                    vstr_len += len(vstr)
                else:
                    leftc = vstr_list[0][0]
                    rightc = vstr[0]
                    if len(vstr) > 1 or ((rightc != leftc or leftc == '1') and
                                         (rightc != '0' or leftc != '1')):
                        extendc = '0' if leftc == '1' else leftc
                        extend_size = size_sum - vstr_len
                        vstr_list.insert(0, extendc * extend_size)
                        vstr_list.insert(0, vstr)
                        vstr_len += extend_size + len(vstr)
                size_sum += size
            value_str = ''.join(vstr_list)
        else:
            value_str = self._format_value(value, self.size, check)
        return f'b{value_str} {self.ident}'
 

Member Data Documentation

__slots__

tuple __slots__ = ()

staticprivate

variables

Definition at line 546 of file writer.py.

---

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

• trg/scripts/writer.py