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, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateMachine
  2. StateMachineAccessor
  3. Area
  4. Nameable
  5. ContextUser
  6. ScalaLocated
  7. GlobalDataUser
  8. OwnableRef
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def add(stateMachine: StateMachineAccessor): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  5. def add(state: State): Int
    Definition Classes
    StateMachine → StateMachineAccessor
  6. def always(doThat: ⇒ Unit): StateMachine.this.type
  7. val alwaysTasks: ArrayBuffer[() ⇒ Unit]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. var autoStart: Boolean
  10. def build(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  11. val cache: HashMap[Any, Any]
  12. def cacheGet(key: Any): Option[Any]
    Definition Classes
    StateMachine → StateMachineAccessor
  13. def cacheGetOrElseUpdate(key: Any, op: ⇒ Any): Any
    Definition Classes
    StateMachineAccessor
  14. def cachePut(key: Any, value: Any): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  15. def checkState(state: State): Unit
  16. val childStateMachines: Set[StateMachineAccessor]
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  18. def component: Component
    Definition Classes
    ContextUser
  19. def disableAutoStart(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  20. var entryState: State
  21. val enumDefinition: StateMachineEnum
  22. def enumOf(state: State): SpinalEnumElement[enumDefinition.type]
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def exitFsm(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  26. def forceGoto(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  27. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def getDisplayName(): String
    Definition Classes
    Nameable
  30. def getEntry(): State
    Definition Classes
    StateMachine → StateMachineAccessor
  31. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  32. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  33. def getName(default: String): String
    Definition Classes
    Nameable
  34. def getName(): String
    Definition Classes
    Nameable
  35. def getPartialName(): String
    Definition Classes
    Nameable
  36. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  37. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  38. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  39. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  40. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  41. def goto(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. implicit val implicitFsm: StateMachine
  44. var inGeneration: Boolean
  45. def isActive(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  46. def isEntering(state: State): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. def isNamed: Boolean
    Definition Classes
    Nameable
  49. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  50. def isStateNextBoot(): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  51. def isStateRegBoot(): Bool
    Definition Classes
    StateMachine → StateMachineAccessor
  52. def isUnnamed: Boolean
    Definition Classes
    Nameable
  53. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  54. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  55. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  57. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  58. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  59. var parentStateMachine: StateMachineAccessor
  60. val postBuildTasks: ArrayBuffer[() ⇒ Unit]
  61. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  62. def reflectNames(): Unit
    Definition Classes
    Nameable
  63. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  64. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  65. def setCompositeName(nameable: Nameable, postfix: String): StateMachine.this.type
    Definition Classes
    Nameable
  66. def setCompositeName(nameable: Nameable, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  67. def setCompositeName(nameable: Nameable, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  68. def setCompositeName(nameable: Nameable): StateMachine.this.type
    Definition Classes
    Nameable
  69. def setEncoding(encoding: SpinalEnumEncoding): Unit
  70. def setEntry(state: State): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  71. def setName(name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  72. def setName(name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  73. def setName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  74. def setParentStateMachine(parent: StateMachineAccessor): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  75. def setPartialName(name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  76. def setPartialName(name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  77. def setPartialName(owner: Nameable, name: String, namePriority: Byte): StateMachine.this.type
    Definition Classes
    Nameable
  78. def setPartialName(owner: Nameable, name: String, weak: Boolean): StateMachine.this.type
    Definition Classes
    Nameable
  79. def setPartialName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  80. def setPartialName(owner: Nameable, name: String): StateMachine.this.type
    Definition Classes
    Nameable
  81. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  82. def setScalaLocated(source: ScalaLocated): StateMachine.this.type
    Definition Classes
    ScalaLocated
  83. 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

  84. def setWeakName(name: String): StateMachine.this.type
    Definition Classes
    Nameable
  85. def startFsm(): Unit
    Definition Classes
    StateMachine → StateMachineAccessor
  86. var stateBoot: State
  87. var stateNext: StateMachineEnum.C
  88. var stateNextCand: StateMachineEnum.C
  89. var stateReg: StateMachineEnum.C
  90. val stateToEnumElement: HashMap[State, SpinalEnumElement[enumDefinition.type]]
  91. val states: ArrayBuffer[State]
  92. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  93. def toString(): String
    Definition Classes
    Area → Nameable → AnyRef → Any
  94. var transitionCond: Bool
  95. def unsetName(): StateMachine.this.type
    Definition Classes
    Nameable
  96. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  98. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  99. val wantExit: Bool

Deprecated Value Members

  1. def finalize(): Unit
    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 Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped