Information about a module. More...
#include <FIRRTLInstanceInfo.h>
Public Attributes | |
| InstanceInfo::LatticeValue | underDut |
| Indicates if this module is instantiated under the design-under-test. | |
| InstanceInfo::LatticeValue | underLayer |
| Indicates if this module is instantiated under a layer. | |
| InstanceInfo::LatticeValue | inDesign |
| Indicates if this module is instantiated in the design. | |
| InstanceInfo::LatticeValue | inEffectiveDesign |
| Indicates if this modules is instantiated in the effective design. | |
| InstanceInfo::LatticeValue | inInstanceChoice |
| Indicates if this module is instantiated within (or transitively within) an instance choice operation. | |
Detailed Description
Information about a module.
Definition at line 102 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 112 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 120 of file FIRRTLInstanceInfo.h.
Referenced by circt::firrtl::InstanceInfo::allInstancesInEffectiveDesign(), circt::firrtl::InstanceInfo::anyInstanceInEffectiveDesign(), and circt::firrtl::InstanceInfo::InstanceInfo().
◆ inInstanceChoice
| InstanceInfo::LatticeValue circt::firrtl::InstanceInfo::ModuleAttributes::inInstanceChoice |
Indicates if this module is instantiated within (or transitively within) an instance choice operation.
Definition at line 124 of file FIRRTLInstanceInfo.h.
Referenced by circt::firrtl::InstanceInfo::anyInstanceInInstanceChoice(), 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 104 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 107 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:
- /home/runner/work/circt-www/circt-www/circt_src/include/circt/Analysis/FIRRTLInstanceInfo.h
