esiaccel.types.WindowType Class Reference

Inheritance diagram for esiaccel.types.WindowType:

Collaboration diagram for esiaccel.types.WindowType:

Classes
class	Field
class	Frame

Public Member Functions
	__init__ (self, str id, str name, "ESIType" into_type, "ESIType" lowered_type, List["WindowType.Frame"] frames)
Tuple[bool, Optional[str]]	supports_host (self)
int	bit_width (self)
Tuple[bool, Optional[str]]	is_valid (self, obj)
bytearray	serialize (self, obj)
Tuple[object, bytearray]	deserialize (self, bytearray data)
Public Member Functions inherited from esiaccel.types.ESIType
	wrap_cpp (cls, cpp.Type cpp_type)
str	id (self)
int	max_size (self)
int	__hash__ (self)
bool	__eq__ (self, other)
str	__str__ (self)

Public Attributes
	name
	into_type
	lowered_type
	frames
Public Attributes inherited from esiaccel.types.ESIType
	cpp_type
	id

Protected Member Functions
	_init_from_cpp (self, cpp.WindowType cpp_type)

Protected Attributes
	_HOST_UNSUPPORTED_REASON

Static Protected Attributes
tuple	_HOST_UNSUPPORTED_REASON

Detailed Description

Definition at line 458 of file types.py.

Constructor & Destructor Documentation

__init__()

esiaccel.types.WindowType.__init__	(		self,
		str	id,
		str	name,
		"ESIType"	into_type,
		"ESIType"	lowered_type,
		List["WindowType.Frame"]	frames
	)

Reimplemented from esiaccel.types.ESIType.

Definition at line 473 of file types.py.

References esiaccel.types.ArrayType._init_from_cpp(), esiaccel.types.BundleType._init_from_cpp(), esiaccel.types.ChannelType._init_from_cpp(), esiaccel.types.ListType._init_from_cpp(), esiaccel.types.StructType._init_from_cpp(), esiaccel.types.ESIType._init_from_cpp(), esiaccel.types.TypeAlias._init_from_cpp(), esiaccel.types.UnionType._init_from_cpp(), and esiaccel.types.WindowType._init_from_cpp().

Referenced by synth.LongestPathCollection.drop_non_critical_paths(), and synth.LongestPathCollection.merge().

Member Function Documentation

_init_from_cpp()

esiaccel.types.WindowType._init_from_cpp (   self, cpp.WindowType  cpp_type  )

protected

Initialize instance attributes from a C++ type object.

Reimplemented from esiaccel.types.ESIType.

Definition at line 486 of file types.py.

References esiaccel.types.WindowType._init_from_cpp().

Referenced by esiaccel.types.ESIType.__init__(), esiaccel.types.VoidType.__init__(), esiaccel.types.AnyType.__init__(), esiaccel.types.ListType.__init__(), esiaccel.types.ArrayType.__init__(), esiaccel.types.ChannelType.__init__(), esiaccel.types.BitsType.__init__(), esiaccel.types.IntType.__init__(), esiaccel.types.UIntType.__init__(), esiaccel.types.SIntType.__init__(), esiaccel.types.BundleType.__init__(), esiaccel.types.StructType.__init__(), esiaccel.types.UnionType.__init__(), esiaccel.types.TypeAlias.__init__(), esiaccel.types.WindowType.__init__(), and esiaccel.types.WindowType._init_from_cpp().

bit_width()

int esiaccel.types.WindowType.bit_width

(

self

)

Size of this type, in bits. Negative for unbounded types.

Reimplemented from esiaccel.types.ESIType.

Definition at line 503 of file types.py.

References esiaccel.types.WindowType.lowered_type.

Referenced by esiaccel.types.UnionType.deserialize(), esiaccel.types.UIntType.is_valid(), esiaccel.types.SIntType.is_valid(), esiaccel.types.ESIType.max_size(), esiaccel.types.UnionType.serialize(), and esiaccel.types.ESIType.supports_host().

deserialize()

Tuple[object, bytearray] esiaccel.types.WindowType.deserialize	(		self,
		bytearray	data
	)

Convert a bytearray to a Python object. Return the object and the
leftover bytes.

Reimplemented from esiaccel.types.ESIType.

Definition at line 512 of file types.py.

References esiaccel.types.WindowType._HOST_UNSUPPORTED_REASON.

is_valid()

Tuple[bool, Optional[str]] esiaccel.types.WindowType.is_valid	(		self,
			obj
	)

Is a Python object compatible with HW type?  Returns either '(True,
None)' if it is, or '(False, reason)' if it is not.

Reimplemented from esiaccel.types.ESIType.

Definition at line 506 of file types.py.

References esiaccel.types.WindowType._HOST_UNSUPPORTED_REASON.

serialize()

bytearray esiaccel.types.WindowType.serialize	(		self,
			obj
	)

Convert a Python object to a bytearray.

Reimplemented from esiaccel.types.ESIType.

Definition at line 509 of file types.py.

References esiaccel.types.WindowType._HOST_UNSUPPORTED_REASON.

supports_host()

Tuple[bool, Optional[str]] esiaccel.types.WindowType.supports_host

(

self

)

Does this type support host communication via Python? Returns either
'(True, None)' if it is, or '(False, reason)' if it is not.

Reimplemented from esiaccel.types.ESIType.

Definition at line 499 of file types.py.

Member Data Documentation

_HOST_UNSUPPORTED_REASON [1/2]

tuple esiaccel.types.WindowType._HOST_UNSUPPORTED_REASON

staticprotected

Initial value:

=  (
      "window types require into/lowered translation and are not yet "
      "supported for host communication")

Definition at line 460 of file types.py.

Referenced by esiaccel.types.WindowType.deserialize(), esiaccel.types.WindowType.is_valid(), and esiaccel.types.WindowType.serialize().

_HOST_UNSUPPORTED_REASON [2/2]

esiaccel.types.WindowType._HOST_UNSUPPORTED_REASON

protected

Definition at line 500 of file types.py.

Referenced by esiaccel.types.WindowType.deserialize(), esiaccel.types.WindowType.is_valid(), and esiaccel.types.WindowType.serialize().

frames

esiaccel.types.WindowType.frames

Definition at line 491 of file types.py.

into_type

esiaccel.types.WindowType.into_type

Definition at line 489 of file types.py.

lowered_type

esiaccel.types.WindowType.lowered_type

Definition at line 490 of file types.py.

Referenced by esiaccel.types.WindowType.bit_width().

name

esiaccel.types.WindowType.name

Definition at line 488 of file types.py.

Referenced by esiaccel.types.TypeAlias.__str__().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/python/esiaccel/types.py