Class

spinal.lib.fsm

StateMachine

Related Doc: package fsm

Permalink

class StateMachine extends Area with StateMachineAccessor with ScalaLocated

State machine

Example:
  1. val fsm = new StateMachine {
      val sIdle: State = StateEntryPoint{
        ...
      }
      val sState1: State = new State {
        whenIsActive{
          goto(sIdle)
        }
      }
      ...
    }
Linear Supertypes
StateMachineAccessor, Area, OverridedEqualsHashCode, ValCallbackRec, ValCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateMachine
  2. StateMachineAccessor
  3. Area
  4. OverridedEqualsHashCode
  5. ValCallbackRec
  6. ValCallback
  7. NameableByComponent
  8. Nameable
  9. ContextUser
  10. ScalaLocated
  11. GlobalDataUser
  12. OwnableRef
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StateMachine()

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val _context: Capture

    Permalink
    Definition Classes
    Area
  5. def add(stateMachine: StateMachineAccessor): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  6. def add(state: State): Int

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  7. def always(doThat: ⇒ Unit): StateMachine.this.type

    Permalink
  8. val alwaysTasks: ArrayBuffer[() ⇒ Unit]

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. var autoStart: Boolean

    Permalink
  11. def build(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  12. var builded: Boolean

    Permalink
  13. val cache: HashMap[Any, Any]

    Permalink
  14. def cacheGet(key: Any): Option[Any]

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  15. def cacheGetOrElseUpdate(key: Any, op: ⇒ Any): Any

    Permalink
    Definition Classes
    StateMachineAccessor
  16. def cachePut(key: Any, value: Any): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  17. def checkState(state: State): Unit

    Permalink
  18. def childNamePriority: Byte

    Permalink
    Definition Classes
    Area
  19. val childStateMachines: LinkedHashSet[StateMachineAccessor]

    Permalink
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  21. def component: Component

    Permalink
    Definition Classes
    ContextUser
  22. var corruptedState: Bool

    Permalink
  23. def disableAutoStart(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  24. var entryState: State

    Permalink
  25. val enumDef: StateMachineEnum

    Permalink
  26. def enumOf(state: State): SpinalEnumElement[enumDef.type]

    Permalink
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  29. def exit(): Unit

    Permalink
  30. def exitFsm(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  31. def forceGoto(state: State): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  32. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  33. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  34. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  35. def getEntry(): State

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  36. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  37. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  38. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  39. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  40. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  41. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  42. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  43. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  44. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  45. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  46. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  47. def goto(state: State): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  48. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  49. implicit val implicitFsm: StateMachine

    Permalink
  50. def inCorruptedState(): Bool

    Permalink
  51. var inGeneration: Boolean

    Permalink
  52. def isActive(state: State): Bool

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  53. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  54. def isEntering(state: State): Bool

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  55. def isExiting(state: State): Bool

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  56. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  57. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  58. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  59. def isRunning: Bool

    Permalink
  60. def isStarted: Bool

    Permalink
  61. def isStateNextBoot(): Bool

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  62. def isStateRegBoot(): Bool

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  63. def isStopped: Bool

    Permalink
  64. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  65. def killFsm(): Unit

    Permalink
  66. def makeInstantEntry(): State

    Permalink
  67. var name: String

    Permalink
    Definition Classes
    Nameable
  68. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  69. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  70. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  71. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  72. def onStart(body: ⇒ Unit): State

    Permalink
  73. def overrideLocalName(name: String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  74. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  75. var parentStateMachine: StateMachineAccessor

    Permalink
  76. def postBuild(body: ⇒ Unit): Unit

    Permalink
  77. val postBuildTasks: ArrayBuffer[() ⇒ Unit]

    Permalink
  78. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  79. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  80. def rework[T](body: ⇒ T): T

    Permalink
    Definition Classes
    Area
  81. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  82. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  84. def setCompositeName(nameable: Nameable, postfix: String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  85. def setCompositeName(nameable: Nameable, namePriority: Byte): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  86. def setCompositeName(nameable: Nameable, weak: Boolean): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  87. def setCompositeName(nameable: Nameable): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  88. def setEncoding(spec: (State, BigInt)*): Unit

    Permalink
  89. def setEncoding(encoding: SpinalEnumEncoding): Unit

    Permalink
  90. def setEntry(state: State): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  91. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  92. def setName(name: String, namePriority: Byte): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  93. def setName(name: String, weak: Boolean): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  94. def setName(name: String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  95. def setNameAsWeak(): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  96. def setParentStateMachine(parent: StateMachineAccessor): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  97. def setPartialName(name: String, namePriority: Byte, owner: Any): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  98. def setPartialName(name: String, namePriority: Byte): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  99. def setPartialName(name: String, weak: Boolean): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  100. def setPartialName(owner: Nameable, name: String, namePriority: Byte): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  101. def setPartialName(owner: Nameable, name: String, weak: Boolean): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  102. def setPartialName(name: String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  103. def setPartialName(owner: Nameable, name: String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  104. def setPartialName(owner: Nameable): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  105. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  106. def setScalaLocated(source: ScalaLocated): StateMachine.this.type

    Permalink
    Definition Classes
    ScalaLocated
  107. def setTransitionCondition(condition: Bool): Unit

    Permalink

    Set the condition for state transitions

    Set the condition for state transitions

    goto() will only have an effect, if condition is True

  108. def setWeakName(name: String): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  109. def startFsm(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  110. var stateBoot: State

    Permalink
  111. var stateNext: StateMachineEnum.C

    Permalink
  112. var stateNextCand: StateMachineEnum.C

    Permalink
  113. var stateReg: StateMachineEnum.C

    Permalink
  114. val stateToEnumElement: HashMap[State, SpinalEnumElement[enumDef.type]]

    Permalink
  115. val states: ArrayBuffer[State]

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

    Permalink
    Definition Classes
    AnyRef
  117. def toString(): String

    Permalink
    Definition Classes
    Area → Nameable → AnyRef → Any
  118. var transitionCond: Bool

    Permalink
  119. def unsetName(): StateMachine.this.type

    Permalink
    Definition Classes
    Nameable
  120. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  121. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  122. def valCallbackRec(obj: Any, name: String): Unit

    Permalink
    Definition Classes
    Area → ValCallbackRec
  123. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. val wantExit: Bool

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  127. val wantKill: Bool

    Permalink
  128. val wantStart: Bool

    Permalink

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from StateMachineAccessor

Inherited from Area

Inherited from OverridedEqualsHashCode

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped