class ChiselCircuitAnnotation extends NoTargetAnnotation with ChiselOption with Unserializable with Product with Serializable

Stores a Chisel Circuit

Source
ChiselAnnotations.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChiselCircuitAnnotation
  2. Serializable
  3. Unserializable
  4. ChiselOption
  5. NoTargetAnnotation
  6. Annotation
  7. Product
  8. Equals
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ChiselCircuitAnnotation(circuit: Circuit)
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 6.7.0) Use factory method with ElaboratedCircuit instead.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toany2stringadd[ChiselCircuitAnnotation] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ChiselCircuitAnnotation, B)
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toArrowAssoc[ChiselCircuitAnnotation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def canEqual(that: Any): Boolean
    Definition Classes
    ChiselCircuitAnnotation → Equals
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def elaboratedCircuit: ElaboratedCircuit
  10. def ensuring(cond: (ChiselCircuitAnnotation) => Boolean, msg: => Any): ChiselCircuitAnnotation
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toEnsuring[ChiselCircuitAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ChiselCircuitAnnotation) => Boolean): ChiselCircuitAnnotation
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toEnsuring[ChiselCircuitAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): ChiselCircuitAnnotation
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toEnsuring[ChiselCircuitAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ChiselCircuitAnnotation
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toEnsuring[ChiselCircuitAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(obj: Any): Boolean
    Definition Classes
    ChiselCircuitAnnotation → Equals → AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. lazy val hashCode: Int
    Definition Classes
    ChiselCircuitAnnotation → AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productArity: Int
    Definition Classes
    ChiselCircuitAnnotation → Product
  24. def productElement(n: Int): Any
    Definition Classes
    ChiselCircuitAnnotation → Product
  25. def productElementName(n: Int): String
    Definition Classes
    Product
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. def productIterator: Iterator[Any]
    Definition Classes
    Product
  28. def productPrefix: String
    Definition Classes
    Product
  29. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def update(renames: RenameMap): Seq[NoTargetAnnotation]

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
    NoTargetAnnotationAnnotation
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def circuit: Circuit
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 6.7.0) Use elaboratedCircuit instead.

  2. def copy(circuit: Circuit = this.circuit): ChiselCircuitAnnotation
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 6.7.0) Don't copy, just create a new one.

  3. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toStringFormat[ChiselCircuitAnnotation] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  4. def [B](y: B): (ChiselCircuitAnnotation, B)
    Implicit
    This member is added by an implicit conversion from ChiselCircuitAnnotation toArrowAssoc[ChiselCircuitAnnotation] 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.

Inherited from Serializable

Inherited from Unserializable

Inherited from ChiselOption

Inherited from NoTargetAnnotation

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromChiselCircuitAnnotation to any2stringadd[ChiselCircuitAnnotation]

Inherited by implicit conversion StringFormat fromChiselCircuitAnnotation to StringFormat[ChiselCircuitAnnotation]

Inherited by implicit conversion Ensuring fromChiselCircuitAnnotation to Ensuring[ChiselCircuitAnnotation]

Inherited by implicit conversion ArrowAssoc fromChiselCircuitAnnotation to ArrowAssoc[ChiselCircuitAnnotation]

Ungrouped