Packages

  • package root

    This is the documentation for Chisel.

    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, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package choice

    This package contains Chisel language definitions for describing configuration options and their accepted values.

    This package contains Chisel language definitions for describing configuration options and their accepted values.

    Definition Classes
    chisel3
  • Case
  • DynamicCase
  • DynamicGroup
  • Group
  • ModuleChoice
c

chisel3.choice

DynamicGroup

abstract class DynamicGroup extends AnyRef

Dynamic option group with runtime-customizable name.

Unlike static Group objects, DynamicGroup allows the group name to be specified at instantiation time. This is useful for parameterized designs where the same group structure is reused with different names.

Source
package.scala
Example:

  1. class Opt(name: String)(implicit sourceInfo: SourceInfo) extends DynamicGroup(name) {
  object Fast extends DynamicCase
  object Slow extends DynamicCase
}

// Use with ModuleChoice
class MyModule extends Module {
  val opt = new Opt("OptMyModule")
  val impl = ModuleChoice(new DefaultImpl)(
    Seq(
      opt.Fast -> new FastImpl,
      opt.Slow -> new SlowImpl
    )
  )
}
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DynamicGroup
  2. AnyRef
  3. 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 DynamicGroup(customName: String)(implicit _sourceInfo: SourceInfo)

    customName

    The runtime name for this group

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 DynamicGroup toany2stringadd[DynamicGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DynamicGroup, B)
    Implicit
    This member is added by an implicit conversion from DynamicGroup toArrowAssoc[DynamicGroup] 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 ensuring(cond: (DynamicGroup) => Boolean, msg: => Any): DynamicGroup
    Implicit
    This member is added by an implicit conversion from DynamicGroup toEnsuring[DynamicGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (DynamicGroup) => Boolean): DynamicGroup
    Implicit
    This member is added by an implicit conversion from DynamicGroup toEnsuring[DynamicGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): DynamicGroup
    Implicit
    This member is added by an implicit conversion from DynamicGroup toEnsuring[DynamicGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): DynamicGroup
    Implicit
    This member is added by an implicit conversion from DynamicGroup toEnsuring[DynamicGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def group: Group
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. implicit def implicitGroup: DynamicGroup
    Attributes
    protected
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. 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 DynamicGroup toStringFormat[DynamicGroup] 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): (DynamicGroup, B)
    Implicit
    This member is added by an implicit conversion from DynamicGroup toArrowAssoc[DynamicGroup] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDynamicGroup to any2stringadd[DynamicGroup]

Inherited by implicit conversion StringFormat fromDynamicGroup to StringFormat[DynamicGroup]

Inherited by implicit conversion Ensuring fromDynamicGroup to Ensuring[DynamicGroup]

Inherited by implicit conversion ArrowAssoc fromDynamicGroup to ArrowAssoc[DynamicGroup]

Ungrouped