synth.Instance Class Reference

Collaboration diagram for synth.Instance:

Public Member Functions
	__init__ (self, hw.InstanceOp instance)
str	instance_name (self)
str	module_name (self)

Protected Attributes
	_instance

Static Protected Attributes
hw	_instance .InstanceOp

Detailed Description

  Represents a single element in a hierarchical instance path.
  In hardware design, modules are instantiated hierarchically. This class
  represents one level in that hierarchy, containing both the module type
  and the specific instance name.
  Attributes:
      instance_name: The name of this specific instance
      module_name: The type/name of the module being instantiated

Definition at line 18 of file synth.py.

Constructor & Destructor Documentation

__init__()

synth.Instance.__init__	(		self,
		hw.InstanceOp	instance
	)

Definition at line 30 of file synth.py.

Referenced by synth.LongestPathCollection.drop_non_critical_paths(), and synth.LongestPathCollection.merge().

Member Function Documentation

instance_name()

str synth.Instance.instance_name

(

self

)

Definition at line 34 of file synth.py.

References synth.Instance._instance.

module_name()

str synth.Instance.module_name

(

self

)

Definition at line 38 of file synth.py.

References synth.Instance._instance.

Member Data Documentation

_instance [1/2]

hw synth.Instance._instance .InstanceOp

staticprotected

Definition at line 28 of file synth.py.

Referenced by synth.Instance.instance_name(), and synth.Instance.module_name().

_instance [2/2]

synth.Instance._instance

protected

Definition at line 31 of file synth.py.

Referenced by synth.Instance.instance_name(), and synth.Instance.module_name().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/lib/Bindings/Python/dialects/synth.py