sealed trait ElaboratedCircuit extends AnyRef
The result of running Chisel elaboration
Provides limited APIs for inspection of the resulting circuit.
- Source
- ElaboratedCircuit.scala
- Alphabetic
- By Inheritance
- ElaboratedCircuit
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def annotations: Iterable[Annotation]
The annotations created during elaboration of this circuit
The annotations created during elaboration of this circuit
This does not include annotations passed to elaboration.
- abstract def lazilySerialize(annotations: Iterable[Annotation]): Iterable[String]
The circuit and annotations as a lazy buffer of strings of FIRRTL IR
The circuit and annotations as a lazy buffer of strings of FIRRTL IR
Serialized lazily to reduce peak memory use and support cicuits larger than 2 GiB.
- annotations
annotations to include in the FIRRTL IR. No other annotations will be included.
- abstract def lazilySerialize: Iterable[String]
The circuit and annotations as a lazy buffer of strings of FIRRTL IR
The circuit and annotations as a lazy buffer of strings of FIRRTL IR
This will include annotations passed to Chisel to build the circuit and those created during elaboration. Serialized lazily to reduce peak memory use and support cicuits larger than 2 GiB.
- abstract def name: String
The name of the circuit, also the name of the top public module
- abstract def serialize(annotations: Iterable[Annotation]): String
The circuit and annotations as a string of FIRRTL IR
The circuit and annotations as a string of FIRRTL IR
For large circuits (> 2 GiB of text) use
lazilySerialize.- annotations
annotations to include in the FIRRTL IR. No other annotations will be included.
- abstract def serialize: String
The circuit and annotations as a string of FIRRTL IR
The circuit and annotations as a string of FIRRTL IR
This will include annotations passed to Chisel to build the circuit and those created during elaboration. For large circuits (> 2 GiB of text) use
lazilySerialize. - abstract def topDefinition: Definition[BaseModule]
The Definition of the top module in the elaborated circuit
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toany2stringadd[ElaboratedCircuit] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ElaboratedCircuit, B)
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toArrowAssoc[ElaboratedCircuit] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (ElaboratedCircuit) => Boolean, msg: => Any): ElaboratedCircuit
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toEnsuring[ElaboratedCircuit] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ElaboratedCircuit) => Boolean): ElaboratedCircuit
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toEnsuring[ElaboratedCircuit] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ElaboratedCircuit
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toEnsuring[ElaboratedCircuit] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ElaboratedCircuit
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toEnsuring[ElaboratedCircuit] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toStringFormat[ElaboratedCircuit] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ElaboratedCircuit, B)
- Implicit
- This member is added by an implicit conversion from ElaboratedCircuit toArrowAssoc[ElaboratedCircuit] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.