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. val cache: HashMap[Any, Any]

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

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

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

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

    Permalink
  17. def childNamePriority: Byte

    Permalink
    Definition Classes
    Area
  18. val childStateMachines: Set[StateMachineAccessor]

    Permalink
  19. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  22. var entryState: State

    Permalink
  23. val enumDefinition: StateMachineEnum

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  33. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  34. def getMode: Byte

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

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

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

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

    Permalink
    Definition Classes
    OwnableRef
  39. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  40. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  42. val globalData: GlobalData

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

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

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

    Permalink
  46. var inGeneration: Boolean

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  48. def isCompletelyUnnamed: Boolean

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

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

    Permalink
    Definition Classes
    Any
  51. def isNamed: Boolean

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

    Permalink
    Definition Classes
    Nameable
  53. def isRunning: Bool

    Permalink
  54. def isStarted: Bool

    Permalink
  55. def isStateNextBoot(): Bool

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  57. def isStopped: Bool

    Permalink
  58. def isUnnamed: Boolean

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

    Permalink
  60. var name: String

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  67. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  68. var parentStateMachine: StateMachineAccessor

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

    Permalink
  70. var refOwner: RefOwnerType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  97. var stateBoot: State

    Permalink
  98. var stateNext: StateMachineEnum.C

    Permalink
  99. var stateNextCand: StateMachineEnum.C

    Permalink
  100. var stateReg: StateMachineEnum.C

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

    Permalink
  102. val states: ArrayBuffer[State]

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    StateMachineStateMachineAccessor
  114. val wantKill: Bool

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