spinal.core

SpinalEnum

Related Doc: package core

class SpinalEnum extends Nameable with ScalaLocated

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
ScalaLocated, GlobalDataUser, Nameable, OwnableRef, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpinalEnum
  2. ScalaLocated
  3. GlobalDataUser
  4. Nameable
  5. OwnableRef
  6. AnyRef
  7. 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. val elements: ArrayBuffer[SpinalEnumElement[SpinalEnum.this.type]]

    Contains all elements of the enumeration

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

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

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

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

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef → Any

  17. def getDisplayName(): String

    Definition Classes
    Nameable

  18. def getName(default: String): String

    Definition Classes
    Nameable

  19. def getName(): String

    Definition Classes
    Nameable

  20. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  21. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  22. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

  23. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def isNamed: Boolean

    Definition Classes
    Nameable

  27. def isUnnamed: Boolean

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef

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

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

    Create a new Element

  31. final def notify(): Unit

    Definition Classes
    AnyRef

  32. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  33. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

  43. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

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

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef

  46. def toString(): String

    Definition Classes
    Nameable → AnyRef → Any

  47. def unsetName(): Unit

    Definition Classes
    Nameable

  48. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from Nameable

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped