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
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- EnumVecAnnotation
- Serializable
- SingleTargetAnnotation
- Annotation
- Product
- Equals
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def duplicate(n: Named): EnumVecAnnotation
- Definition Classes
- EnumVecAnnotation → SingleTargetAnnotation
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fields: Seq[Seq[String]]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getTargets: Seq[Target]
- Definition Classes
- SingleTargetAnnotation → 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
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serialize: String
- Definition Classes
- Annotation
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val target: Named
- Definition Classes
- EnumVecAnnotation → SingleTargetAnnotation
- val typeName: String
- def update(renames: RenameMap): Seq[Annotation]
- Definition Classes
- SingleTargetAnnotation → Annotation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt,SInt,Bool,FixedPoint,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.