Packages

c

circt

ConventionAnnotation

case class ConventionAnnotation(target: ModuleTarget, convention: String) extends SingleTargetAnnotation[ModuleTarget] with Product with Serializable

Annotation to specify a module's port convention. The port convention defines how the ports of a module are transformed while lowering to verilog.

Source
Convention.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConventionAnnotation
  2. Serializable
  3. SingleTargetAnnotation
  4. Annotation
  5. Product
  6. Equals
  7. AnyRef
  8. 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 ConventionAnnotation(target: ModuleTarget, convention: String)

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 ConventionAnnotation toany2stringadd[ConventionAnnotation] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConventionAnnotation, B)
    Implicit
    This member is added by an implicit conversion from ConventionAnnotation toArrowAssoc[ConventionAnnotation] 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 convention: String
  9. def duplicate(target: ModuleTarget): ConventionAnnotation

    Create another instance of this Annotation

    Create another instance of this Annotation

    Definition Classes
    ConventionAnnotationSingleTargetAnnotation
  10. def ensuring(cond: (ConventionAnnotation) => Boolean, msg: => Any): ConventionAnnotation
    Implicit
    This member is added by an implicit conversion from ConventionAnnotation toEnsuring[ConventionAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ConventionAnnotation) => Boolean): ConventionAnnotation
    Implicit
    This member is added by an implicit conversion from ConventionAnnotation toEnsuring[ConventionAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): ConventionAnnotation
    Implicit
    This member is added by an implicit conversion from ConventionAnnotation toEnsuring[ConventionAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ConventionAnnotation
    Implicit
    This member is added by an implicit conversion from ConventionAnnotation toEnsuring[ConventionAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val target: ModuleTarget
  25. def update(renames: RenameMap): Seq[Annotation]

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
    SingleTargetAnnotationAnnotation
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. 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 ConventionAnnotation toStringFormat[ConventionAnnotation] 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): (ConventionAnnotation, B)
    Implicit
    This member is added by an implicit conversion from ConventionAnnotation toArrowAssoc[ConventionAnnotation] 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 Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromConventionAnnotation to any2stringadd[ConventionAnnotation]

Inherited by implicit conversion StringFormat fromConventionAnnotation to StringFormat[ConventionAnnotation]

Inherited by implicit conversion Ensuring fromConventionAnnotation to Ensuring[ConventionAnnotation]

Inherited by implicit conversion ArrowAssoc fromConventionAnnotation to ArrowAssoc[ConventionAnnotation]

Ungrouped