esi::TypeAliasType Class Reference

Type aliases provide a named type which forwards to an inner type. More...

#include <Types.h>

Inheritance diagram for esi::TypeAliasType:

Collaboration diagram for esi::TypeAliasType:

Public Member Functions
	TypeAliasType (const ID &id, std::string name, const Type *innerType)
const std::string &	getName () const
const Type *	getInnerType () const
std::ptrdiff_t	getBitWidth () const override
void	ensureValid (const std::any &obj) const override
	Ensure that a std::any object is valid for this type.
MutableBitVector	serialize (const std::any &obj) const override
	Serialize an object to a MutableBitVector (LSB-first stream).
std::any	deserialize (BitVector &data) const override
	Deserialize from a BitVector stream (LSB-first).
std::any	deserialize (const MessageData &data) const
Public Member Functions inherited from esi::Type
	Type (const ID &id)
virtual	~Type ()=default
ID	getID () const
void	setHWBitwidth (std::ptrdiff_t bw)
	Set from manifest JSON hwBitwidth.
std::any	deserialize (const MessageData &data) const
std::optional< std::string >	isValid (const std::any &obj) const
void	dump (std::ostream &os, bool oneLine=false) const
std::string	toString (bool oneLine=false) const

Private Attributes
std::string	name
const Type *	innerType

Additional Inherited Members
Public Types inherited from esi::Type
using	ID = std::string
Protected Attributes inherited from esi::Type
ID	id
std::ptrdiff_t	hwBitwidth = -1

Detailed Description

Type aliases provide a named type which forwards to an inner type.

Definition at line 166 of file Types.h.

Constructor & Destructor Documentation

TypeAliasType()

esi::TypeAliasType::TypeAliasType ( const ID & id, std::string name, const Type * innerType )

inline

Definition at line 170 of file Types.h.

References assert(), esi::Type::id, innerType, name, and esi::Type::Type().

Member Function Documentation

deserialize() [1/2]

std::any esi::TypeAliasType::deserialize ( BitVector & data ) const

overridevirtual

Deserialize from a BitVector stream (LSB-first).

Implementations consume bits from 'data' in-place (via logical right shifts) and return the reconstructed value. Remaining bits stay in 'data'.

Reimplemented from esi::Type.

Definition at line 185 of file Types.cpp.

References innerType.

deserialize() [2/2]

std::any esi::Type::deserialize ( const MessageData & data ) const

inline

Definition at line 67 of file Types.h.

ensureValid()

void esi::TypeAliasType::ensureValid ( const std::any & obj ) const

overridevirtual

Ensure that a std::any object is valid for this type.

Throws std::runtime_error if the object is not valid.

Reimplemented from esi::Type.

Definition at line 177 of file Types.cpp.

References innerType.

getBitWidth()

std::optional< int64_t > TypeAliasType::getBitWidth ( ) const

inlineoverridevirtual

Reimplemented from esi::Type.

Definition at line 179 of file Types.h.

References innerType.

getInnerType()

const Type * esi::TypeAliasType::getInnerType ( ) const

inline

Definition at line 177 of file Types.h.

References innerType, and esi::Type::Type().

Referenced by NB_MODULE().

getName()

const std::string & esi::TypeAliasType::getName ( ) const

inline

Definition at line 176 of file Types.h.

References name.

Referenced by NB_MODULE().

serialize()

MutableBitVector esi::TypeAliasType::serialize ( const std::any & obj ) const

overridevirtual

Serialize an object to a MutableBitVector (LSB-first stream).

The object should be passed via std::any. Implementations append fields in the order they are iterated (the first serialized field occupies the least-significant bits of the result).

Reimplemented from esi::Type.

Definition at line 181 of file Types.cpp.

References innerType.

Member Data Documentation

innerType

const Type* esi::TypeAliasType::innerType

private

Definition at line 189 of file Types.h.

Referenced by deserialize(), ensureValid(), getBitWidth(), getInnerType(), serialize(), and TypeAliasType().

name

std::string esi::TypeAliasType::name

private

Definition at line 188 of file Types.h.

Referenced by esiaccel.types.TypeAlias::__str__(), getName(), and TypeAliasType().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Types.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Types.cpp
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/HW/HWTypes.cpp