Trait/Object

chisel3.util

Enum

Related Docs: object Enum | package util

Permalink

trait Enum extends AnyRef

Defines a set of unique UInt constants

Unpack with a list to specify an enumeration. Usually used with switch to describe a finite state machine.

Source
Enum.scala
Example: 

  1. val state_on :: state_off :: Nil = Enum(2)
val current_state = WireDefault(state_off)
switch (current_state) {
  is (state_on) {
    ...
  }
  is (state_off) {
    ...
  }
}
Linear Supertypes
AnyRef, Any
Known Subclasses
Enum, Enum
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Enum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def apply(n: Int): List[UInt]

    Permalink

    Returns n unique UInt values

    Returns n unique UInt values

    n

    Number of unique UInt constants to enumerate

    returns

    Enumerated constants

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. def createValues(n: Int): Seq[UInt]

    Permalink

    Returns a sequence of Bits subtypes with values from 0 until n.

    Returns a sequence of Bits subtypes with values from 0 until n. Helper method.

    Attributes
    protected

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped