Information about a module. More...

#include <FIRRTLInstanceInfo.h>

Collaboration diagram for circt::firrtl::InstanceInfo::ModuleAttributes:

[legend]

Public Attributes
InstanceInfo::LatticeValue	underDut
	Indicates if this module is instantiated under the design-under-test. More...

InstanceInfo::LatticeValue	underLayer
	Indicates if this module is instantiated under a layer. More...

InstanceInfo::LatticeValue	inDesign
	Indicates if this module is instantiated in the design. More...

InstanceInfo::LatticeValue	inEffectiveDesign
	Indicates if this modules is instantiated in the effective design. More...

Detailed Description

Information about a module.

Definition at line 93 of file FIRRTLInstanceInfo.h.

Member Data Documentation

◆ inDesign

InstanceInfo::LatticeValue circt::firrtl::InstanceInfo::ModuleAttributes::inDesign

Indicates if this module is instantiated in the design.

The "design" is defined as being under the design-under-test, excluding verification code (e.g., layers).

Definition at line 103 of file FIRRTLInstanceInfo.h.

Referenced by circt::firrtl::InstanceInfo::allInstancesInDesign(), circt::firrtl::InstanceInfo::anyInstanceInDesign(), and circt::firrtl::InstanceInfo::InstanceInfo().

◆ inEffectiveDesign

InstanceInfo::LatticeValue circt::firrtl::InstanceInfo::ModuleAttributes::inEffectiveDesign

Indicates if this modules is instantiated in the effective design.

The "effective design" is defined as the design-under-test (DUT), excluding verification code (e.g., layers). If a DUT is specified, then this is the same as inDesign. However, if there is no DUT, then every module is deemed to be in the design except those which are explicitly verification code.

Definition at line 111 of file FIRRTLInstanceInfo.h.

Referenced by circt::firrtl::InstanceInfo::allInstancesInEffectiveDesign(), circt::firrtl::InstanceInfo::anyInstanceInEffectiveDesign(), and circt::firrtl::InstanceInfo::InstanceInfo().

◆ underDut

InstanceInfo::LatticeValue circt::firrtl::InstanceInfo::ModuleAttributes::underDut

Indicates if this module is instantiated under the design-under-test.

Definition at line 95 of file FIRRTLInstanceInfo.h.

Referenced by circt::firrtl::InstanceInfo::allInstancesUnderDut(), circt::firrtl::InstanceInfo::anyInstanceUnderDut(), and circt::firrtl::InstanceInfo::InstanceInfo().

◆ underLayer

InstanceInfo::LatticeValue circt::firrtl::InstanceInfo::ModuleAttributes::underLayer

Indicates if this module is instantiated under a layer.

Definition at line 98 of file FIRRTLInstanceInfo.h.

Referenced by circt::firrtl::InstanceInfo::allInstancesUnderLayer(), circt::firrtl::InstanceInfo::anyInstanceUnderLayer(), and circt::firrtl::InstanceInfo::InstanceInfo().

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