circt::firrtl::FIRRTLType Class Reference

#include <FIRRTLTypes.h>

Inheritance diagram for circt::firrtl::FIRRTLType:

Collaboration diagram for circt::firrtl::FIRRTLType:

Public Member Functions
RecursiveTypeProperties	getRecursiveTypeProperties () const
	Return the recursive properties of the type, containing the isPassive, containsAnalog, and hasUninferredWidth bits, among others.
bool	containsConst ()
	Returns true if this is or contains a 'const' type.
bool	containsAnalog ()
	Return true if this is or contains an Analog type.
bool	containsReference ()
	Return true if this is or contains a Reference type.
bool	containsTypeAlias ()
	Return true if this is an anonymous type (no type alias).
bool	hasUninferredWidth ()
	Return true if this type contains an uninferred bit width.
bool	hasUninferredReset ()
	Return true if this type contains an uninferred bit reset.
bool	isGround ()
	Return true if this is a 'ground' type, aka a non-aggregate type.
bool	isConst () const
	Returns true if this is a 'const' type that can only hold compile-time constant values.

Static Public Member Functions
static bool	classof (Type type)
	Support method to enable LLVM-style type casting.

Detailed Description

Definition at line 87 of file FIRRTLTypes.h.

Member Function Documentation

classof()

static bool circt::firrtl::FIRRTLType::classof ( Type  type )

inlinestatic

Support method to enable LLVM-style type casting.

Definition at line 90 of file FIRRTLTypes.h.

containsAnalog()

bool circt::firrtl::FIRRTLType::containsAnalog ( )

inline

Return true if this is or contains an Analog type.

Definition at line 106 of file FIRRTLTypes.h.

References circt::firrtl::RecursiveTypeProperties::containsAnalog, and getRecursiveTypeProperties().

containsConst()

bool circt::firrtl::FIRRTLType::containsConst ( )

inline

Returns true if this is or contains a 'const' type.

Definition at line 103 of file FIRRTLTypes.h.

References circt::firrtl::RecursiveTypeProperties::containsConst, and getRecursiveTypeProperties().

containsReference()

bool circt::firrtl::FIRRTLType::containsReference ( )

inline

Return true if this is or contains a Reference type.

Definition at line 109 of file FIRRTLTypes.h.

References circt::firrtl::RecursiveTypeProperties::containsReference, and getRecursiveTypeProperties().

containsTypeAlias()

bool circt::firrtl::FIRRTLType::containsTypeAlias ( )

inline

Return true if this is an anonymous type (no type alias).

Definition at line 114 of file FIRRTLTypes.h.

References circt::firrtl::RecursiveTypeProperties::containsTypeAlias, and getRecursiveTypeProperties().

getRecursiveTypeProperties()

RecursiveTypeProperties circt::firrtl::FIRRTLType::getRecursiveTypeProperties

(

)

const

Return the recursive properties of the type, containing the isPassive, containsAnalog, and hasUninferredWidth bits, among others.

Referenced by containsAnalog(), containsConst(), containsReference(), containsTypeAlias(), hasUninferredReset(), hasUninferredWidth(), and circt::firrtl::detail::OpenVectorTypeStorage::OpenVectorTypeStorage().

hasUninferredReset()

bool circt::firrtl::FIRRTLType::hasUninferredReset ( )

inline

Return true if this type contains an uninferred bit reset.

Definition at line 124 of file FIRRTLTypes.h.

References getRecursiveTypeProperties(), and circt::firrtl::RecursiveTypeProperties::hasUninferredReset.

hasUninferredWidth()

bool circt::firrtl::FIRRTLType::hasUninferredWidth ( )

inline

Return true if this type contains an uninferred bit width.

Definition at line 119 of file FIRRTLTypes.h.

References getRecursiveTypeProperties(), and circt::firrtl::RecursiveTypeProperties::hasUninferredWidth.

isConst()

bool circt::firrtl::FIRRTLType::isConst

(

)

const

Returns true if this is a 'const' type that can only hold compile-time constant values.

Referenced by circt::firrtl::areTypesEquivalent().

isGround()

bool circt::firrtl::FIRRTLType::isGround

(

)

Return true if this is a 'ground' type, aka a non-aggregate type.

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/FIRRTL/FIRRTLTypes.h