circt::firrtl::ClassElement Struct Reference

#include <FIRRTLTypes.h>

Collaboration diagram for circt::firrtl::ClassElement:

Public Member Functions
	ClassElement (StringAttr name, Type type, Direction direction)
StringRef	getName () const
bool	isInput () const
	Return true if this is a simple output-only element. More...
bool	isOutput () const
	Return true if this is a simple input-only element. More...
bool	isInOut () const
	Return true if this is an inout port. More...
bool	operator== (const ClassElement &rhs) const
bool	operator!= (const ClassElement &rhs) const

Public Attributes
StringAttr	name
Type	type
Direction	direction

Detailed Description

Definition at line 335 of file FIRRTLTypes.h.

Constructor & Destructor Documentation

ClassElement()

circt::firrtl::ClassElement::ClassElement ( StringAttr  name, Type  type, Direction  direction  )

inline

Definition at line 336 of file FIRRTLTypes.h.

Member Function Documentation

getName()

StringRef circt::firrtl::ClassElement::getName ( ) const

inline

Definition at line 343 of file FIRRTLTypes.h.

References name.

isInOut()

bool circt::firrtl::ClassElement::isInOut ( ) const

inline

Return true if this is an inout port.

This will be true if the port contains either bi-directional signals or analog types. Non-HW types (e.g., ref types) are never considered InOut.

Definition at line 356 of file FIRRTLTypes.h.

References circt::firrtl::isTypeInOut(), and type.

Referenced by isInput(), and isOutput().

isInput()

bool circt::firrtl::ClassElement::isInput ( ) const

inline

Return true if this is a simple output-only element.

If you want the direction of the port, use the direction field directly.

Definition at line 347 of file FIRRTLTypes.h.

References direction, circt::firrtl::In, and isInOut().

isOutput()

bool circt::firrtl::ClassElement::isOutput ( ) const

inline

Return true if this is a simple input-only element.

If you want the direction of the port, use the direction field directly.

Definition at line 351 of file FIRRTLTypes.h.

References direction, isInOut(), and circt::firrtl::Out.

operator!=()

bool circt::firrtl::ClassElement::operator!= ( const ClassElement &  rhs ) const

inline

Definition at line 362 of file FIRRTLTypes.h.

operator==()

bool circt::firrtl::ClassElement::operator== ( const ClassElement &  rhs ) const

inline

Definition at line 358 of file FIRRTLTypes.h.

References name, and type.

Member Data Documentation

direction

Direction circt::firrtl::ClassElement::direction

Definition at line 341 of file FIRRTLTypes.h.

Referenced by circt::firrtl::hash_value(), isInput(), and isOutput().

name

StringAttr circt::firrtl::ClassElement::name

Definition at line 339 of file FIRRTLTypes.h.

Referenced by getName(), circt::firrtl::hash_value(), and operator==().

type

Type circt::firrtl::ClassElement::type

Definition at line 340 of file FIRRTLTypes.h.

Referenced by fsm.MachineOp::__init__(), hw.HWModuleOp::add_entry_block(), circt::firrtl::hash_value(), hw.HWModuleOp::input_indices(), fsm.MachineOp::instantiate(), isInOut(), operator==(), hw.HWModuleOp::outputs(), esiaccel.types.ReadPort::read(), and esiaccel.types.WritePort::write().

---

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

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