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, ValCallbackRec, ValCallback, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateMachine
  2. StateMachineAccessor
  3. Area
  4. ValCallbackRec
  5. ValCallback
  6. Nameable
  7. ContextUser
  8. ScalaLocated
  9. GlobalDataUser
  10. OwnableRef
  11. AnyRef
  12. 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. def add(stateMachine: StateMachineAccessor): Unit

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

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

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

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. var autoStart: Boolean

    Permalink
  10. def build(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  11. val cache: HashMap[Any, Any]

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

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

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

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

    Permalink
  16. val childStateMachines: Set[StateMachineAccessor]

    Permalink
  17. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ContextUser
  19. def disableAutoStart(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  20. var entryState: State

    Permalink
  21. val enumDefinition: StateMachineEnum

    Permalink
  22. def enumOf(state: State): SpinalEnumElement[enumDefinition.type]

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

    Permalink
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  25. def exitFsm(): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  31. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  32. def getMode: Byte

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

    Permalink
    Definition Classes
    Nameable
  34. def getName(): String

    Permalink
    Definition Classes
    Nameable
  35. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  36. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  37. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  38. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  40. val globalData: GlobalData

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

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  43. implicit val implicitFsm: StateMachine

    Permalink
  44. var inGeneration: Boolean

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  46. def isEntering(state: State): Bool

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

    Permalink
    Definition Classes
    Any
  48. def isNamed: Boolean

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

    Permalink
    Definition Classes
    Nameable
  50. def isStarted: Bool

    Permalink
  51. def isStateNextBoot(): Bool

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  53. def isStopped: Bool

    Permalink
  54. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  55. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  56. var nameableRef: Nameable

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  62. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  63. var parentStateMachine: StateMachineAccessor

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

    Permalink
  65. var refOwner: RefOwnerType

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  73. def setEncoding(encoding: SpinalEnumEncoding): Unit

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ScalaLocated
  88. 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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  91. var stateBoot: State

    Permalink
  92. var stateNext: StateMachineEnum.C

    Permalink
  93. var stateNextCand: StateMachineEnum.C

    Permalink
  94. var stateReg: StateMachineEnum.C

    Permalink
  95. val stateToEnumElement: HashMap[State, SpinalEnumElement[enumDefinition.type]]

    Permalink
  96. val states: ArrayBuffer[State]

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  108. 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 ValCallbackRec

Inherited from ValCallback

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped