c

chisel3.stage

DesignAnnotation

case class DesignAnnotation[DUT <: RawModule](design: DUT) extends NoTargetAnnotation with Unserializable with Product with Serializable

Contains the top-level elaborated Chisel design.

By default is created during Chisel elaboration and passed to the FIRRTL compiler.

DUT

Type of the top-level Chisel design

design

top-level Chisel design

Source
ChiselAnnotations.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DesignAnnotation
  2. Serializable
  3. Unserializable
  4. NoTargetAnnotation
  5. Annotation
  6. Product
  7. Equals
  8. AnyRef
  9. 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 DesignAnnotation(design: DUT)

    design

    top-level Chisel design

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 DesignAnnotation[DUT] toany2stringadd[DesignAnnotation[DUT]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DesignAnnotation[DUT], B)
    Implicit
    This member is added by an implicit conversion from DesignAnnotation[DUT] toArrowAssoc[DesignAnnotation[DUT]] 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val design: DUT
  9. def ensuring(cond: (DesignAnnotation[DUT]) => Boolean, msg: => Any): DesignAnnotation[DUT]
    Implicit
    This member is added by an implicit conversion from DesignAnnotation[DUT] toEnsuring[DesignAnnotation[DUT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (DesignAnnotation[DUT]) => Boolean): DesignAnnotation[DUT]
    Implicit
    This member is added by an implicit conversion from DesignAnnotation[DUT] toEnsuring[DesignAnnotation[DUT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): DesignAnnotation[DUT]
    Implicit
    This member is added by an implicit conversion from DesignAnnotation[DUT] toEnsuring[DesignAnnotation[DUT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): DesignAnnotation[DUT]
    Implicit
    This member is added by an implicit conversion from DesignAnnotation[DUT] toEnsuring[DesignAnnotation[DUT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. 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
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DesignAnnotation[DUT] toStringFormat[DesignAnnotation[DUT]] 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.

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

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDesignAnnotation[DUT] to any2stringadd[DesignAnnotation[DUT]]

Inherited by implicit conversion StringFormat fromDesignAnnotation[DUT] to StringFormat[DesignAnnotation[DUT]]

Inherited by implicit conversion Ensuring fromDesignAnnotation[DUT] to Ensuring[DesignAnnotation[DUT]]

Inherited by implicit conversion ArrowAssoc fromDesignAnnotation[DUT] to ArrowAssoc[DesignAnnotation[DUT]]

Ungrouped