ScalarVariable Class Reference

Inheritance diagram for ScalarVariable:

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

Static Private Attributes
tuple	__slots__ = ()
	variables

Detailed Description

One-bit VCD scalar.

This is a 4-state variable and thus may have values of 0, 1, 'z', or 'x'.

Definition at line 481 of file writer.py.

Member Function Documentation

format_value()

def format_value	(		self,
			value,
			check = True
	)

Format scalar value change for VCD stream.

:param value: 1-bit (4-state) scalar value.
:type value: str, bool, int, or None
:raises ValueError: for invalid *value*.
:returns: string representing value change for use in a VCD stream.

Reimplemented from Variable.

Definition at line 491 of file writer.py.

    def format_value(self, value, check=True):
        """Format scalar value change for VCD stream.
 
        :param value: 1-bit (4-state) scalar value.
        :type value: str, bool, int, or None
        :raises ValueError: for invalid *value*.
        :returns: string representing value change for use in a VCD stream.
 
        """
        if isinstance(value, str):
            if check and (len(value) != 1 or value not in '01xzXZ'):
                raise ValueError(f'Invalid scalar value ({value})')
            return value + self.ident
        elif value is None:
            return 'z' + self.ident
        elif value:
            return '1' + self.ident
        else:
            return '0' + self.ident
 
 

Member Data Documentation

__slots__

tuple __slots__ = ()

staticprivate

variables

Definition at line 489 of file writer.py.

---

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

• trg/scripts/writer.py