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. def disableAutoStart(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  23. var entryState: State
  24. val enumDef: StateMachineEnum
  25. def enumOf(state: State): SpinalEnumElement[enumDef.type]
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  28. def exitFsm(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  29. def forceGoto(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  30. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  31. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def getDisplayName(): String
    Definition Classes
    Nameable
  33. def getEntry(): State
    Definition Classes
    StateMachine → StateMachineAccessor
  34. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  35. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  36. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  37. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  38. def getPartialName(): String
    Definition Classes
    Nameable
  39. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  40. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  41. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  42. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  43. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  44. def goto(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  45. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  46. implicit val implicitFsm: StateMachine
  47. var inGeneration: Boolean
  48. def isActive(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  49. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  50. def isEntering(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  53. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  54. def isRunning: Bool
  55. def isStarted: Bool
  56. def isStateNextBoot(): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  57. def isStateRegBoot(): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  58. def isStopped: Bool
  59. def isUnnamed: Boolean
    Definition Classes
    Nameable
  60. def killFsm(): Unit
  61. def makeInstantEntry(): State
  62. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  63. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  67. def onStart(body: => Unit): State
  68. def overrideLocalName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  69. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  70. var parentStateMachine: StateMachineAccessor
  71. val postBuildTasks: ArrayBuffer[() => Unit]
  72. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  73. def reflectNames(): Unit
    Definition Classes
    Nameable
  74. def rework[T](body: => T): T
    Definition Classes
    Area
  75. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  76. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  77. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  78. def setCompositeName(nameable: Nameable, postfix: String): StateMachine.this.type
    Definition Classes
    Nameable
  79. def setCompositeName(nameable: Nameable, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  80. def setCompositeName(nameable: Nameable, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  81. def setCompositeName(nameable: Nameable): StateMachine.this.type
    Definition Classes
    Nameable
  82. def setEncoding(encoding: SpinalEnumEncoding): Unit
  83. def setEntry(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  84. def setName(name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  85. def setName(name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  86. def setName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  87. def setNameAsWeak(): StateMachine.this.type
    Definition Classes
    Nameable
  88. def setParentStateMachine(parent: StateMachineAccessor): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  89. def setPartialName(name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  90. def setPartialName(name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  91. def setPartialName(owner: Nameable, name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  92. def setPartialName(owner: Nameable, name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  93. def setPartialName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  94. def setPartialName(owner: Nameable, name: String): StateMachine.this.type
    Definition Classes
    Nameable
  95. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  96. def setScalaLocated(source: ScalaLocated): StateMachine.this.type
    Definition Classes
    ScalaLocated
  97. 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

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