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. def disableAutoStart(): Unit

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  23. var entryState: State

    Permalink
  24. val enumDef: StateMachineEnum

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  34. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  35. def getMode: Byte

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

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

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

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

    Permalink
    Definition Classes
    OwnableRef
  40. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  41. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  43. val globalData: GlobalData

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

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

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

    Permalink
  47. var inGeneration: Boolean

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  49. def isCompletelyUnnamed: Boolean

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

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

    Permalink
    Definition Classes
    Any
  52. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  53. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  54. def isRunning: Bool

    Permalink
  55. def isStarted: Bool

    Permalink
  56. def isStateNextBoot(): Bool

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  58. def isStopped: Bool

    Permalink
  59. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  60. def killFsm(): Unit

    Permalink
  61. def makeInstantEntry(): State

    Permalink
  62. var name: String

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  69. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  70. var parentStateMachine: StateMachineAccessor

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

    Permalink
  72. var refOwner: RefOwnerType

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

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

    Permalink
    Definition Classes
    Area
  75. var scalaTrace: Throwable

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  100. var stateBoot: State

    Permalink
  101. var stateNext: StateMachineEnum.C

    Permalink
  102. var stateNextCand: StateMachineEnum.C

    Permalink
  103. var stateReg: StateMachineEnum.C

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

    Permalink
  105. val states: ArrayBuffer[State]

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  117. val wantKill: Bool

    Permalink
  118. 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