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.

Linear Supertypes
Serializable, Serializable, SingleTargetAnnotation[Named], Annotation, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnumVecAnnotation
  2. Serializable
  3. Serializable
  4. SingleTargetAnnotation
  5. Annotation
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def duplicate(n: Named): EnumVecAnnotation
    Definition Classes
    EnumVecAnnotation → SingleTargetAnnotation
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val fields: Seq[Seq[String]]
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getTargets: Seq[Target]
    Definition Classes
    Annotation
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def serialize: String
    Definition Classes
    Annotation
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. val target: Named
    Definition Classes
    EnumVecAnnotation → SingleTargetAnnotation
  19. val typeName: String
  20. def update(renames: RenameMap): Seq[Annotation]
    Definition Classes
    SingleTargetAnnotation → Annotation
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from SingleTargetAnnotation[Named]

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped