Packages

c

spinal.core

SpinalEnum

class SpinalEnum extends Nameable with ScalaLocated

Base class for creating enumeration

Example: 

  1. object MyEnum extends SpinalEnum(binarySequential){
  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, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpinalEnum
  2. Nameable
  3. ContextUser
  4. ScalaLocated
  5. GlobalDataUser
  6. OwnableRef
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
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
    @native() @throws( ... )
  8. def component: Component
    Definition Classes
    ContextUser
  9. def craft(enumEncoding: SpinalEnumEncoding): SpinalEnumCraft[SpinalEnum.this.type]
  10. def craft(): SpinalEnumCraft[SpinalEnum.this.type]
  11. var defaultEncoding: SpinalEnumEncoding
  12. val elements: ArrayBuffer[SpinalEnumElement[SpinalEnum.this.type]]

    Contains all elements of the enumeration

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getDisplayName(): String
    Definition Classes
    Nameable
  19. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  20. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  21. def getName(default: String): String
    Definition Classes
    Nameable
  22. def getName(): String
    Definition Classes
    Nameable
  23. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  24. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  25. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  26. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  27. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isNamed: Boolean
    Definition Classes
    Nameable
  31. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  32. def isUnnamed: Boolean
    Definition Classes
    Nameable
  33. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  34. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def newElement(name: String): SpinalEnumElement[SpinalEnum.this.type]
  37. def newElement(): SpinalEnumElement[SpinalEnum.this.type]

    Create a new Element

  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  41. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @dontName()
  42. def reflectNames(): Unit
    Definition Classes
    Nameable
  43. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  44. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  45. def setCompositeName(nameable: Nameable, postfix: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  46. def setCompositeName(nameable: Nameable, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  47. def setCompositeName(nameable: Nameable, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  48. def setCompositeName(nameable: Nameable): SpinalEnum.this.type
    Definition Classes
    Nameable
  49. def setName(name: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  50. def setName(name: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  51. def setName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  52. def setPartialName(name: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  53. def setPartialName(name: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  54. def setPartialName(owner: Nameable, name: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  55. def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  56. def setPartialName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  57. def setPartialName(owner: Nameable, name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  58. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  59. def setScalaLocated(source: ScalaLocated): SpinalEnum.this.type
    Definition Classes
    ScalaLocated
  60. def setWeakName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  61. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  62. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  63. def unsetName(): SpinalEnum.this.type
    Definition Classes
    Nameable
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped