spinal.core

SpinalEnum

Related Doc: package core

class SpinalEnum extends Nameable

Base class for creating enumeration

Example: 

  1. class MyEnum extends SpinalEnum(binarySequancial){
  val s1, s2, s3, s4 = newElement()
}

    SpinalEnum contains a list of SpinalEnumElement that is the definition of an element. SpinalEnumCraft is the hardware representation of the the element.

See also

Enumeration Documentation

Linear Supertypes
Nameable, OwnableRef, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpinalEnum
  2. Nameable
  3. OwnableRef
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpinalEnum(defaultEncoding: SpinalEnumEncoding = native)

    defaultEncoding

    encoding of the enum

Type Members

  1. type C = SpinalEnumCraft[SpinalEnum.this.type]

  2. type E = SpinalEnumElement[SpinalEnum.this.type]

  3. abstract type RefOwnerType

    Definition Classes
    OwnableRef

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. def apply(encoding: SpinalEnumEncoding): SpinalEnumCraft[SpinalEnum.this.type]

  5. def apply(): SpinalEnumCraft[SpinalEnum.this.type]

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def craft(enumEncoding: SpinalEnumEncoding): SpinalEnumCraft[SpinalEnum.this.type]

  9. def craft(): SpinalEnumCraft[SpinalEnum.this.type]

  10. var defaultEncoding: SpinalEnumEncoding

    encoding of the enum

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

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

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

  14. def forEachNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef → Any

  16. def getDisplayName(): String

    Definition Classes
    Nameable

  17. def getName(default: String): String

    Definition Classes
    Nameable

  18. def getName(): String

    Definition Classes
    Nameable

  19. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. def isNamed: Boolean

    Definition Classes
    Nameable

  23. def isUnnamed: Boolean

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef

  25. def newElement(name: String): SpinalEnumElement[SpinalEnum.this.type]

  26. def newElement(): SpinalEnumElement[SpinalEnum.this.type]

    Create a new Element

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

  30. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalEnum.this.type

    Definition Classes
    Nameable

  31. def setCompositeName(nameable: Nameable, postfix: String): SpinalEnum.this.type

    Definition Classes
    Nameable

  32. def setCompositeName(nameable: Nameable, weak: Boolean): SpinalEnum.this.type

    Definition Classes
    Nameable

  33. def setCompositeName(nameable: Nameable): SpinalEnum.this.type

    Definition Classes
    Nameable

  34. def setName(name: String, weak: Boolean = false): SpinalEnum.this.type

    Definition Classes
    Nameable

  35. def setPartialName(name: String, weak: Boolean): SpinalEnum.this.type

    Definition Classes
    Nameable

  36. def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalEnum.this.type

    Definition Classes
    Nameable

  37. def setPartialName(name: String): SpinalEnum.this.type

    Definition Classes
    Nameable

  38. def setPartialName(owner: Nameable, name: String): SpinalEnum.this.type

    Definition Classes
    Nameable

  39. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

  40. def setWeakName(name: String): SpinalEnum.this.type

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef

  42. def toString(): String

    Definition Classes
    Nameable → AnyRef → Any

  43. def unsetName(): Unit

    Definition Classes
    Nameable

  44. val values: ArrayBuffer[SpinalEnumElement[SpinalEnum.this.type]]

    Contains all elements of the enumeration

  45. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Nameable

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped