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
Known Subclasses
FragmentToBitsStates, AhbLite3ToApb3BridgePhase, Phase, Axi4ToApb3BridgePhase, Axi4ToBRAMPhase, Response, BmbExclusiveMonitorState, I2cSlaveCmdMode, JtagState, JtagTapState, SpiMasterCtrlCmdMode, UartCtrlRxState, UartCtrlTxState, UartParityType, UartStopType, MainState, RxKind, DebugCaptureOp, DebugDmToHartOp, DebugModuleCmdErr, DebugUpdateOp, DataCacheCpuCmdKind, ALU, BR, CSR, M, MFS, MSK, MWR, OP0, OP1, PC, WB, SerialCheckerRxState, SerialCheckerTxState, SerialLinkRxState, SerialLinkTxState, SerialSafeLayerRxState, StateMachineEnum, SdramCtrlBackendTask, SdramCtrlFrontendState, FrontendCmdOutputKind
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 senum

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  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. var forcedGlobalEnable: Option[Boolean]
  16. var forcedPrefixEnable: Option[Boolean]
  17. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. def getDisplayName(): String
    Definition Classes
    Nameable
  20. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  21. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  22. def getName(default: String): String
    Definition Classes
    Nameable
  23. def getName(): String
    Definition Classes
    Nameable
  24. def getPartialName(): String
    Definition Classes
    Nameable
  25. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  26. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  27. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  28. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  29. def getSignature(): Any
  30. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  32. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. final def isNamed: Boolean
    Definition Classes
    Nameable
  35. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  36. def isUnnamed: Boolean
    Definition Classes
    Nameable
  37. val name: String
    Definition Classes
    Nameable
  38. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def newElement(name: String): SpinalEnumElement[SpinalEnum.this.type]
  41. def newElement(): SpinalEnumElement[SpinalEnum.this.type]

    Create a new Element

  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  44. def overrideLocalName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  45. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  46. def rawElementName(): Unit
  47. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  48. def reflectNames(): Unit
    Definition Classes
    Nameable
  49. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  50. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  51. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  52. def setCompositeName(nameable: Nameable, postfix: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  53. def setCompositeName(nameable: Nameable, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  54. def setCompositeName(nameable: Nameable, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  55. def setCompositeName(nameable: Nameable): SpinalEnum.this.type
    Definition Classes
    Nameable
  56. def setGlobal(): Unit
  57. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): SpinalEnum.this.type
    Definition Classes
    Nameable
  58. def setLocal(): Unit
  59. def setName(name: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  60. def setName(name: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  61. def setName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  62. def setNameAsWeak(): SpinalEnum.this.type
    Definition Classes
    Nameable
  63. def setPartialName(name: String, namePriority: Byte, owner: Any): SpinalEnum.this.type
    Definition Classes
    Nameable
  64. def setPartialName(name: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  65. def setPartialName(name: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  66. def setPartialName(owner: Nameable, name: String, namePriority: Byte): SpinalEnum.this.type
    Definition Classes
    Nameable
  67. def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalEnum.this.type
    Definition Classes
    Nameable
  68. def setPartialName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  69. def setPartialName(owner: Nameable, name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  70. def setPartialName(owner: Nameable): SpinalEnum.this.type
    Definition Classes
    Nameable
  71. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  72. def setScalaLocated(source: ScalaLocated): SpinalEnum.this.type
    Definition Classes
    ScalaLocated
  73. def setWeakName(name: String): SpinalEnum.this.type
    Definition Classes
    Nameable
  74. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  75. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  76. def unsetName(): SpinalEnum.this.type
    Definition Classes
    Nameable
  77. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  78. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  79. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped