synth.Object Class Reference

Collaboration diagram for synth.Object:

Public Member Functions
str	__str__ (self)
str	__repr__ (self)
List[Instance]	instance_path (self)
str	name (self)
int	bit_pos (self)
Optional[Value]	value (self)
bool	is_output_port (self)

Public Attributes
	instance_path

Static Protected Attributes
_LongestPathObject	_object

Detailed Description

  Represents a signal or port object in the dataflow graph.
  This class encapsulates a specific signal within the hardware hierarchy,
  including its location in the instance hierarchy, signal name, and bit position
  for multi-bit signals.
  Attributes:
      instance_path: Hierarchical path to the module containing this object
      name: The signal/port name within the module
      bit_pos: Bit position for multi-bit signals (0 for single-bit)

Definition at line 43 of file synth.py.

Member Function Documentation

__repr__()

str synth.Object.__repr__

(

self

)

Definition at line 68 of file synth.py.

__str__()

str synth.Object.__str__

(

self

)

    Generate a human-readable string representation of this object.
    Format: "module1:instance1/module2:instance2 signal_name[bit_pos]"

Definition at line 59 of file synth.py.

bit_pos()

int synth.Object.bit_pos

(

self

)

Get the bit position for multi-bit signals.

Definition at line 84 of file synth.py.

References synth.Object._object.

instance_path()

List[Instance] synth.Object.instance_path

(

self

)

Get the hierarchical instance path to this object.

Definition at line 72 of file synth.py.

References synth.Object._object.

is_output_port()

bool synth.Object.is_output_port

(

self

)

Check if this object represents an output port.

Definition at line 94 of file synth.py.

References circt::DIVariable.value, circt::firrtl::InstanceInfo::LatticeValue.value, circt::firrtl::ContainAliasableTypes< head, tail >.value, circt::firrtl::ContainAliasableTypes< BaseTy >.value, circt::om::evaluator::ReferenceValue.value, circt::synth::Object.value, circt::Backedge.value, circt::StringAttrOrRef.value, circt::FieldRef.value, circt::FVInt.value, synth.Object.value(), List.value, BasePath.value, Path.value, Object.value, Python.support.OpOperand.value, esi::Constant.value, ConnectInfo.value, Specialized< T >.value, ValueSlice.value, DriveSlice.value, Signal.value, circt::llhd::deseq::ValueEntry.value, circt::llhd::deseq::ResetInfo.value, circt::llhd::deseq::ClockInfo.value, circt::llhd::deseq::FixedValue.value, DriveOperands.value, Def.value, Interval.value, circt::rtg::detail::ImmediateAttrStorage.value, ValidationMuxedValue.value, and ValueWithArrivalTime.value.

name()

str synth.Object.name

(

self

)

Get the name of this signal/port.

Definition at line 79 of file synth.py.

References synth.Object._object.

value()

Optional[Value] synth.Object.value

(

self

)

Get the MLIR value associated with this object, if any.

Definition at line 89 of file synth.py.

References synth.Object._object.

Referenced by circt::synth::Object.getName(), synth.Object.is_output_port(), and Python.support.OpOperand.type().

Member Data Documentation

_object

_LongestPathObject synth.Object._object

staticprotected

Definition at line 55 of file synth.py.

Referenced by synth.Object.bit_pos(), synth.Object.instance_path(), synth.Object.name(), and synth.Object.value().

instance_path

synth.Object.instance_path

Definition at line 65 of file synth.py.

---

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