esiaccel.types.ChannelType Class Reference

Inheritance diagram for esiaccel.types.ChannelType:

Collaboration diagram for esiaccel.types.ChannelType:

Public Member Functions
	__init__ (self, str id, "ESIType" inner)
"ESIType"	inner (self)
Tuple[bool, Optional[str]]	supports_host (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
	__init__ (self, str id)
	wrap_cpp (cls, cpp.Type cpp_type)
str	id (self)
int	bit_width (self)
int	max_size (self)
int	__hash__ (self)
bool	__eq__ (self, other)
str	__str__ (self)

Public Attributes
	inner_type = _get_esi_type(cpp_type.inner)
Public Attributes inherited from esiaccel.types.ESIType
	cpp_type = cpp_type
str	id

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

Detailed Description

Definition at line 107 of file types.py.

Constructor & Destructor Documentation

__init__()

esiaccel.types.ChannelType.__init__	(		self,
		str	id,
		"ESIType"	inner )

Definition at line 109 of file types.py.

References esiaccel.types.ESIType._init_from_cpp().

Member Function Documentation

_init_from_cpp()

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

protected

Initialize instance attributes from a C++ type object.

Reimplemented from esiaccel.types.ESIType.

Definition at line 112 of file types.py.

References _init_from_cpp().

Referenced by _init_from_cpp().

deserialize()

Tuple[object, bytearray] esiaccel.types.ChannelType.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 130 of file types.py.

References deserialize(), and inner_type.

Referenced by deserialize().

inner()

"ESIType" esiaccel.types.ChannelType.inner

(

self

)

Definition at line 117 of file types.py.

References inner_type.

is_valid()

Tuple[bool, Optional[str]] esiaccel.types.ChannelType.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 124 of file types.py.

References inner_type, and is_valid().

Referenced by is_valid().

serialize()

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

Convert a Python object to a bytearray.

Reimplemented from esiaccel.types.ESIType.

Definition at line 127 of file types.py.

References inner_type, and serialize().

Referenced by serialize().

supports_host()

Tuple[bool, Optional[str]] esiaccel.types.ChannelType.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 121 of file types.py.

References inner_type.

Member Data Documentation

inner_type

esiaccel.types.ChannelType.inner_type = _get_esi_type(cpp_type.inner)

Definition at line 114 of file types.py.

Referenced by deserialize(), esiaccel.types.TypeAlias.deserialize(), inner(), is_valid(), esiaccel.types.TypeAlias.is_valid(), serialize(), esiaccel.types.TypeAlias.serialize(), and supports_host().

---

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