VectorVariable Class Reference

Inheritance diagram for VectorVariable:

Collaboration diagram for VectorVariable:

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

Public Attributes
	ident
	Identifier used in VCD output stream.
	type
	VCD variable type; one of :const:VCDWriter.VAR_TYPES.
	size
	Size, in bits, of variable.

Private 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 542 of file writer.py.

Member Function Documentation

_format_value()

def _format_value (   self,   value,   size,   check  )

private

format value function of VCDWriter

Definition at line 599 of file writer.py.

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 553 of file writer.py.

---

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

• trg/scripts/writer.py