spinal.core

SpinalEnumCraft

Related Doc: package core

class SpinalEnumCraft[T <: SpinalEnum] extends BaseType with InferableEnumEncodingImpl with DataPrimitives[SpinalEnumCraft[T]]

Hardware representation of an enumeration

Linear Supertypes
DataPrimitives[SpinalEnumCraft[T]], InferableEnumEncodingImpl, InferableEnumEncoding, EnumEncoded, BaseType, Expression, StatementDoubleLinkedContainer[BaseType, AssignmentStatement], DoubleLinkedContainer[BaseType, AssignmentStatement], DeclarationStatement, LeafStatement, Statement, BaseNode, ExpressionContainer, Data, ScalaLocated, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpinalEnumCraft
  2. DataPrimitives
  3. InferableEnumEncodingImpl
  4. InferableEnumEncoding
  5. EnumEncoded
  6. BaseType
  7. Expression
  8. StatementDoubleLinkedContainer
  9. DoubleLinkedContainer
  10. DeclarationStatement
  11. LeafStatement
  12. Statement
  13. BaseNode
  14. ExpressionContainer
  15. Data
  16. ScalaLocated
  17. SpinalTagReady
  18. Assignable
  19. NameableByComponent
  20. Nameable
  21. OwnableRef
  22. ContextUser
  23. GlobalDataUser
  24. AnyRef
  25. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpinalEnumCraft(spinalEnum: T)

Type Members

  1. abstract type RefOwnerType

    Definition Classes
    OwnableRef

Value Members

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

    Definition Classes
    AnyRef → Any

  2. def ##(right: Data): Bits

    Definition Classes
    Data

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def :=(that: SpinalEnumElement[T]): Unit

  5. def :=(that: SpinalEnumCraft[T]): Unit

    Definition Classes
    DataPrimitives

  6. def <>(that: SpinalEnumCraft[T]): Unit

    Definition Classes
    DataPrimitives

  7. def =/=(that: SpinalEnumElement[T]): Bool

  8. def =/=(that: SpinalEnumCraft[T]): Bool

    Definition Classes
    DataPrimitives

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

    Definition Classes
    AnyRef → Any

  10. def ===(that: SpinalEnumElement[T]): Bool

  11. def ===(that: SpinalEnumCraft[T]): Bool

    Definition Classes
    DataPrimitives

  12. def \(that: SpinalEnumCraft[T]): SpinalEnumCraft[T]

    Definition Classes
    DataPrimitives

  13. var _spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady

  14. def addAttribute(attribute: Attribute): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data → SpinalTagReady

  15. def addAttribute(name: String, value: String): SpinalEnumCraft.this.type

    Definition Classes
    SpinalTagReady

  16. def addAttribute(name: String): SpinalEnumCraft.this.type

    Definition Classes
    SpinalTagReady

  17. def addTag(spinalTag: SpinalTag): SpinalEnumCraft.this.type

    Definition Classes
    SpinalTagReady

  18. def addTags(tags: Iterable[SpinalTag]): SpinalEnumCraft.this.type

    Definition Classes
    SpinalTagReady

  19. var algoIncrementale: Int

    Definition Classes
    BaseNode

  20. var algoInt: Int

    Definition Classes
    BaseNode

  21. def allowDirectionLessIo: SpinalEnumCraft.this.type

    Definition Classes
    Data

  22. def allowOverride: SpinalEnumCraft.this.type

    Definition Classes
    Data

  23. def allowPruning(): Unit

    Definition Classes
    Data

  24. def allowSimplifyIt(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

  25. def allowUnsetRegToAvoidLatch: SpinalEnumCraft.this.type

    Definition Classes
    Data

  26. def asBits: Bits

    Definition Classes
    SpinalEnumCraft → Data

  27. def asData: Data

    Definition Classes
    Data

  28. def asDirectionLess(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

  29. def asInOut(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

  30. def asInput(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

  31. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  32. def asOutput(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

  33. def assignDontCare(): SpinalEnumCraft.this.type

    Definition Classes
    SpinalEnumCraft → Data

  34. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

    Definition Classes
    Data

  35. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Definition Classes
    SpinalEnumCraft → Data

  36. def assignFromBits(bits: Bits): Unit

    Definition Classes
    SpinalEnumCraft → Data

  37. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Definition Classes
    Data

  38. def bootInferration(): Unit

    Definition Classes
    InferableEnumEncodingImpl → InferableEnumEncoding

  39. var clockDomain: ClockDomain

    Definition Classes
    BaseType

  40. def clone(): SpinalEnumCraft.this.type

    Definition Classes
    SpinalEnumCraft → BaseType → Data → AnyRef

  41. def component: Component

    Definition Classes
    ContextUser

  42. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Definition Classes
    Assignable

  43. var compositeAssign: Assignable

    Definition Classes
    Assignable

  44. def copyEncodingConfig(that: InferableEnumEncodingImpl): Unit

    Definition Classes
    InferableEnumEncodingImpl

  45. def default(that: ⇒ SpinalEnumCraft[T]): SpinalEnumCraft[T]

    Definition Classes
    DataPrimitives

  46. def dirString(): String

    Definition Classes
    Data

  47. def dlcAppend(that: AssignmentStatement): SpinalEnumCraft.this.type

    Definition Classes
    DoubleLinkedContainer

  48. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

    Definition Classes
    DoubleLinkedContainer

  49. def dlcHasOnlyOne: Boolean

    Definition Classes
    DoubleLinkedContainer

  50. var dlcHead: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer

  51. def dlcIsEmpty: Boolean

    Definition Classes
    DoubleLinkedContainer

  52. var dlcLast: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer

  53. def dlcPrepend(that: AssignmentStatement): SpinalEnumCraft.this.type

    Definition Classes
    DoubleLinkedContainer

  54. def dontSimplifyIt(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

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

    Definition Classes
    AnyRef

  56. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  57. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Definition Classes
    SpinalTagReady

  58. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Definition Classes
    SpinalTagReady

  59. def finalize(): Unit

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

  60. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Definition Classes
    SpinalTagReady

  61. def fixEncoding(e: SpinalEnumEncoding): Unit

    Definition Classes
    InferableEnumEncodingImpl

  62. def flatten: Seq[BaseType]

    Definition Classes
    BaseType → Data

  63. def flattenLocalName: Seq[String]

    Definition Classes
    BaseType → Data

  64. def flip(): SpinalEnumCraft.this.type

    Definition Classes
    Data

  65. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

    Definition Classes
    BaseType → Statement

  66. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    ExpressionContainer

  67. def foreachExpression(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    DeclarationStatement → ExpressionContainer

  68. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable

  69. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

    Definition Classes
    StatementDoubleLinkedContainer

  70. def genIf(cond: Boolean): SpinalEnumCraft.this.type

    Definition Classes
    Data

  71. def getBitsWidth: Int

    Definition Classes
    SpinalEnumCraft → Data

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

    Definition Classes
    AnyRef → Any

  73. def getComponent(): Component

    Definition Classes
    Data → NameableByComponent

  74. def getComponents(): Seq[Component]

    Definition Classes
    Data

  75. def getDefinition: SpinalEnum

    Definition Classes
    SpinalEnumCraft → EnumEncoded

  76. def getDisplayName(): String

    Definition Classes
    Nameable

  77. def getDrivingReg: SpinalEnumCraft.this.type

    Definition Classes
    BaseType

  78. def getEncoding: SpinalEnumEncoding

    Definition Classes
    InferableEnumEncodingImpl → EnumEncoded

  79. def getInstanceCounter: Int

    Definition Classes
    ContextUser

  80. def getName(): String

    Definition Classes
    NameableByComponent → Nameable

  81. def getName(default: String): String

    Definition Classes
    Nameable

  82. def getRealSource: Any

    Definition Classes
    Assignable

  83. def getRealSourceNoRec: Any

    Definition Classes
    Data → Assignable

  84. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  85. def getRootParent: Data

    Definition Classes
    Data

  86. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  87. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

  88. def getSingleDriver: Option[SpinalEnumCraft.this.type]

    Definition Classes
    BaseType

  89. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Definition Classes
    SpinalTagReady

  90. def getTypeObject: Any

    Definition Classes
    SpinalEnumCraft → Expression

  91. def getZero: SpinalEnumCraft.this.type

    Definition Classes
    SpinalEnumCraft → Data

  92. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

  93. def hasInit: Boolean

    Definition Classes
    BaseType

  94. def hasOnlyOneStatement: Boolean

    Definition Classes
    StatementDoubleLinkedContainer

  95. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady

  96. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  97. def head: AssignmentStatement

    Definition Classes
    StatementDoubleLinkedContainer

  98. def init(enumElement: SpinalEnumElement[T]): SpinalEnumCraft.this.type

  99. def init(that: SpinalEnumCraft[T]): SpinalEnumCraft[T]

    Definition Classes
    DataPrimitives

  100. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Definition Classes
    Data

  101. def insertNext(s: Statement): Unit

    Definition Classes
    Statement

  102. def instanceAttributes(language: Language): Iterable[Attribute]

    Definition Classes
    SpinalTagReady

  103. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady

  104. def isAnalog: Boolean

    Definition Classes
    BaseType → Data

  105. def isComb: Boolean

    Definition Classes
    BaseType → Data

  106. def isDirectionLess: Boolean

    Definition Classes
    Data

  107. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady

  108. def isEquals(that: Any): Bool

    Definition Classes
    SpinalEnumCraft → Data

  109. def isInOut: Boolean

    Definition Classes
    Data

  110. def isInput: Boolean

    Definition Classes
    Data

  111. def isInputOrInOut: Boolean

    Definition Classes
    Data

  112. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  113. def isNamed: Boolean

    Definition Classes
    Nameable

  114. def isNotEquals(that: Any): Bool

    Definition Classes
    SpinalEnumCraft → Data

  115. def isOutput: Boolean

    Definition Classes
    Data

  116. def isOutputOrInOut: Boolean

    Definition Classes
    Data

  117. def isReg: Boolean

    Definition Classes
    BaseType → Data

  118. def isTypeNode: Boolean

    Definition Classes
    BaseType

  119. def isUnnamed: Boolean

    Definition Classes
    Nameable

  120. def isUsingResetSignal: Boolean

    Definition Classes
    BaseType

  121. def isUsingSoftResetSignal: Boolean

    Definition Classes
    BaseType

  122. def isVital: Boolean

    Definition Classes
    BaseType

  123. def keep(): SpinalEnumCraft.this.type

    Definition Classes
    Data

  124. var lastScopeStatement: Statement

    Definition Classes
    Statement

  125. def mux[T2 <: Data](mappings: (Any, T2)*): T2

    Definition Classes
    BaseType

  126. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Definition Classes
    BaseType

  127. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Definition Classes
    BaseType

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

    Definition Classes
    AnyRef

  129. var nextScopeStatement: Statement

    Definition Classes
    Statement

  130. def normalizeInputs: Unit

    Definition Classes
    SpinalEnumCraft → BaseType → ExpressionContainer

  131. final def notify(): Unit

    Definition Classes
    AnyRef

  132. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  133. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Definition Classes
    SpinalTagReady

  134. def opName: String

    Definition Classes
    SpinalEnumCraft → Expression

  135. var parent: Data

    Definition Classes
    Data

  136. var parentScope: ScopeStatement

    Definition Classes
    ContextUser

  137. def propagateEncoding: Boolean

    Definition Classes
    InferableEnumEncodingImpl → EnumEncoded

  138. def pull(): SpinalEnumCraft.this.type

    Definition Classes
    Data

  139. def randBoot(): SpinalEnumCraft.this.type

    Definition Classes
    Data

  140. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

  141. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    ExpressionContainer

  142. def remapExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    DeclarationStatement → ExpressionContainer

  143. def removeAssignments(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType

  144. def removeStatement(): Unit

    Definition Classes
    BaseType → Statement

  145. def removeStatementFromScope(): Unit

    Definition Classes
    Statement

  146. def removeTag(spinalTag: SpinalTag): SpinalEnumCraft.this.type

    Definition Classes
    SpinalTagReady

  147. def removeTags(tags: Iterable[SpinalTag]): SpinalEnumCraft.this.type

    Definition Classes
    SpinalTagReady

  148. def resized: SpinalEnumCraft.this.type

    Definition Classes
    Data

  149. def rootScopeStatement: ScopeStatement

    Definition Classes
    BaseType → Statement

  150. def setAsAnalog(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType → Data

  151. def setAsComb(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType

  152. def setAsReg(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType

  153. def setAsTypeNode(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType

  154. def setAsVital(): SpinalEnumCraft.this.type

    Definition Classes
    BaseType

  155. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  156. def setCompositeName(nameable: Nameable, postfix: String): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  157. def setCompositeName(nameable: Nameable, weak: Boolean): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  158. def setCompositeName(nameable: Nameable): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  159. def setName(name: String, weak: Boolean = false): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  160. def setPartialName(name: String, weak: Boolean): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  161. def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  162. def setPartialName(name: String): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  163. def setPartialName(owner: Nameable, name: String): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  164. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

  165. def setScalaLocated(source: ScalaLocated): SpinalEnumCraft.this.type

    Definition Classes
    ScalaLocated

  166. def setWeakName(name: String): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  167. def simplifyNode: Expression

    Definition Classes
    Expression

  168. val spinalEnum: T

  169. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady

  170. def swapEncoding(encoding: SpinalEnumEncoding): Unit

    Definition Classes
    InferableEnumEncodingImpl → EnumEncoded

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

    Definition Classes
    AnyRef

  172. def toString(): String

    Definition Classes
    BaseType → Expression → Nameable → AnyRef → Any

  173. def toStringMultiLine(): String

    Definition Classes
    BaseNode

  174. def unsetName(): SpinalEnumCraft.this.type

    Definition Classes
    Nameable

  175. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  178. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    ExpressionContainer

  179. def walkExpression(func: (Expression) ⇒ Unit): Unit

    Definition Classes
    ExpressionContainer

  180. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

    Definition Classes
    Statement

  181. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

    Definition Classes
    Statement

  182. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    ExpressionContainer

  183. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

    Definition Classes
    ExpressionContainer

  184. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Definition Classes
    BaseType

Deprecated Value Members

  1. def !==(that: SpinalEnumElement[T]): Bool

    Annotations
    @deprecated
    Deprecated

    Use =/= instead

Inherited from DataPrimitives[SpinalEnumCraft[T]]

Inherited from InferableEnumEncodingImpl

Inherited from InferableEnumEncoding

Inherited from EnumEncoded

Inherited from BaseType

Inherited from Expression

Inherited from StatementDoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DeclarationStatement

Inherited from LeafStatement

Inherited from Statement

Inherited from BaseNode

Inherited from ExpressionContainer

Inherited from Data

Inherited from ScalaLocated

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped