c

spinal.lib.fsm

StateMachine

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
UsbDataRxFsm, UsbDataTxFsm, UsbTokenRxFsm, UsbTokenTxFsm, StateMachineSlave
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. Protected

Instance Constructors

  1. new StateMachine()

Type Members

  1. 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. val _context: Capture
    Definition Classes
    Area
  5. def add(stateMachine: StateMachineAccessor): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  6. def add(state: State): Int
    Definition Classes
    StateMachine → StateMachineAccessor
  7. def always(doThat: => Unit): StateMachine.this.type
  8. val alwaysTasks: ArrayBuffer[() => Unit]
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. var autoStart: Boolean
  11. def build(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  12. var builded: Boolean
  13. val cache: HashMap[Any, Any]
  14. def cacheGet(key: Any): Option[Any]
    Definition Classes
    StateMachine → StateMachineAccessor
  15. def cacheGetOrElseUpdate(key: Any, op: => Any): Any
    Definition Classes
    StateMachineAccessor
  16. def cachePut(key: Any, value: Any): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  17. def checkState(state: State): Unit
  18. def childNamePriority: Byte
    Definition Classes
    Area
  19. val childStateMachines: LinkedHashSet[StateMachineAccessor]
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  21. def component: Component
    Definition Classes
    ContextUser
  22. var corruptedState: Bool
  23. def disableAutoStart(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  24. var entryState: State
  25. val enumDef: StateMachineEnum
  26. def enumOf(state: State): SpinalEnumElement[enumDef.type]
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  29. def exitFsm(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  30. def forceGoto(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  31. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def getDisplayName(): String
    Definition Classes
    Nameable
  34. def getEntry(): State
    Definition Classes
    StateMachine → StateMachineAccessor
  35. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  36. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  37. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  38. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  39. def getPartialName(): String
    Definition Classes
    Nameable
  40. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  41. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  42. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  43. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  44. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  45. def goto(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  46. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  47. implicit val implicitFsm: StateMachine
  48. def inCorruptedState(): Bool
  49. var inGeneration: Boolean
  50. def isActive(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  51. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  52. def isEntering(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  53. def isExiting(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  56. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  57. def isRunning: Bool
  58. def isStarted: Bool
  59. def isStateNextBoot(): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  60. def isStateRegBoot(): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  61. def isStopped: Bool
  62. def isUnnamed: Boolean
    Definition Classes
    Nameable
  63. def killFsm(): Unit
  64. def makeInstantEntry(): State
  65. val name: String
    Definition Classes
    Nameable
  66. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  67. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  70. def onStart(body: => Unit): State
  71. def overrideLocalName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  72. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  73. var parentStateMachine: StateMachineAccessor
  74. def postBuild(body: => Unit): Unit
  75. val postBuildTasks: ArrayBuffer[() => Unit]
  76. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  77. def reflectNames(): Unit
    Definition Classes
    Nameable
  78. def rework[T](body: => T): T
    Definition Classes
    Area
  79. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  80. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  81. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  82. def setCompositeName(nameable: Nameable, postfix: String): StateMachine.this.type
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  84. def setCompositeName(nameable: Nameable, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  85. def setCompositeName(nameable: Nameable): StateMachine.this.type
    Definition Classes
    Nameable
  86. def setEncoding(spec: (State, BigInt)*): Unit
  87. def setEncoding(encoding: SpinalEnumEncoding): Unit
  88. def setEntry(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  89. def setName(name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  90. def setName(name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  91. def setName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  92. def setNameAsWeak(): StateMachine.this.type
    Definition Classes
    Nameable
  93. def setParentStateMachine(parent: StateMachineAccessor): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  94. def setPartialName(name: String, namePriority: Byte, owner: Any): StateMachine.this.type
    Definition Classes
    Nameable
  95. def setPartialName(name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  96. def setPartialName(name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  97. def setPartialName(owner: Nameable, name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  98. def setPartialName(owner: Nameable, name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  99. def setPartialName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  100. def setPartialName(owner: Nameable, name: String): StateMachine.this.type
    Definition Classes
    Nameable
  101. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  102. def setScalaLocated(source: ScalaLocated): StateMachine.this.type
    Definition Classes
    ScalaLocated
  103. def setTransitionCondition(condition: Bool): Unit

    Set the condition for state transitions

    Set the condition for state transitions

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

  104. def setWeakName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  105. def startFsm(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  106. var stateBoot: State
  107. var stateNext: StateMachineEnum.C
  108. var stateNextCand: StateMachineEnum.C
  109. var stateReg: StateMachineEnum.C
  110. val stateToEnumElement: HashMap[State, SpinalEnumElement[enumDef.type]]
  111. val states: ArrayBuffer[State]
  112. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  113. def toString(): String
    Definition Classes
    Area → Nameable → AnyRef → Any
  114. var transitionCond: Bool
  115. def unsetName(): StateMachine.this.type
    Definition Classes
    Nameable
  116. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  117. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  118. def valCallbackRec(obj: Any, name: String): Unit
    Definition Classes
    Area → ValCallbackRec
  119. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  120. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  121. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  122. val wantExit: Bool
  123. val wantKill: Bool
  124. val wantStart: Bool

Deprecated Value Members

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

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