Packages

case class EnumVecAnnotation(target: Named, typeName: String, fields: Seq[Seq[String]]) extends SingleTargetAnnotation[Named] with Product with Serializable

An annotation for Vecs of strong enums.

The fields parameter deserves special attention, since it may be difficult to understand. Suppose you create a the following Vec:

VecInit(new Bundle {
  val e = MyEnum()
  val b = new Bundle {
    val inner_e = MyEnum()
  }
  val v = Vec(3, MyEnum())
}

Then, the fields parameter will be: Seq(Seq("e"), Seq("b", "inner_e"), Seq("v")). Note that for any Vec that doesn't contain Bundles, this field will simply be an empty Seq.

target

the Vec being annotated

typeName

the name of the enum's type (e.g. "mypackage.MyEnum")

fields

a list of all chains of elements leading from the Vec instance to its inner enum fields.

Source
EnumAnnotations.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnumVecAnnotation
  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 EnumVecAnnotation(target: Named, typeName: String, fields: Seq[Seq[String]])

    target

    the Vec being annotated

    typeName

    the name of the enum's type (e.g. "mypackage.MyEnum")

    fields

    a list of all chains of elements leading from the Vec instance to its inner enum fields.

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

    Create another instance of this Annotation

    Create another instance of this Annotation

    Definition Classes
    EnumVecAnnotationSingleTargetAnnotation
  9. def ensuring(cond: (EnumVecAnnotation) => Boolean, msg: => Any): EnumVecAnnotation
    Implicit
    This member is added by an implicit conversion from EnumVecAnnotation toEnsuring[EnumVecAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (EnumVecAnnotation) => Boolean): EnumVecAnnotation
    Implicit
    This member is added by an implicit conversion from EnumVecAnnotation toEnsuring[EnumVecAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): EnumVecAnnotation
    Implicit
    This member is added by an implicit conversion from EnumVecAnnotation toEnsuring[EnumVecAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): EnumVecAnnotation
    Implicit
    This member is added by an implicit conversion from EnumVecAnnotation toEnsuring[EnumVecAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val fields: Seq[Seq[String]]
  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: Named
  25. val typeName: String
  26. 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
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. 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 EnumVecAnnotation toStringFormat[EnumVecAnnotation] 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): (EnumVecAnnotation, B)
    Implicit
    This member is added by an implicit conversion from EnumVecAnnotation toArrowAssoc[EnumVecAnnotation] 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 fromEnumVecAnnotation to any2stringadd[EnumVecAnnotation]

Inherited by implicit conversion StringFormat fromEnumVecAnnotation to StringFormat[EnumVecAnnotation]

Inherited by implicit conversion Ensuring fromEnumVecAnnotation to Ensuring[EnumVecAnnotation]

Inherited by implicit conversion ArrowAssoc fromEnumVecAnnotation to ArrowAssoc[EnumVecAnnotation]

Ungrouped