EnumVecAnnotation

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

Instance Constructors

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def duplicate(n: Named): EnumVecAnnotation

Definition Classes
EnumVecAnnotation → SingleTargetAnnotation
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val fields: Seq[Seq[String]]

a list of all chains of elements leading from the Vec instance to its inner enum fields.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getTargets: Seq[Target]

Definition Classes
Annotation
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def serialize: String

Definition Classes
Annotation
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val target: Named

the Vec being annotated
the Vec being annotated

Definition Classes
EnumVecAnnotation → SingleTargetAnnotation
val typeName: String

the name of the enum's type (e.g.
the name of the enum's type (e.g. "mypackage.MyEnum")
def update(renames: RenameMap): Seq[Annotation]

Definition Classes
SingleTargetAnnotation → Annotation
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package EnumAnnotations

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

Instance Constructors

new EnumVecAnnotation(target: Named, typeName: String, fields: Seq[Seq[String]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def duplicate(n: Named): EnumVecAnnotation

final def eq(arg0: AnyRef): Boolean

val fields: Seq[Seq[String]]

def finalize(): Unit

final def getClass(): Class[_]

def getTargets: Seq[Target]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def serialize: String

final def synchronized[T0](arg0: ⇒ T0): T0

val target: Named

val typeName: String

def update(renames: RenameMap): Seq[Annotation]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

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