spinal.lib.fsm

StateMachine

Related Doc: package fsm

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
Learn more about member selection
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
    @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 finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  27. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable

  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  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 getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  36. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  37. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

  38. def getScalaTrace(): Throwable

    Definition Classes
    ScalaLocated

  39. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

  40. def goto(state: State): Unit

    Definition Classes
    StateMachine → StateMachineAccessor

  41. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  42. implicit val implicitFsm: StateMachine

  43. var inGeneration: Boolean

  44. def isActive(state: State): Bool

    Definition Classes
    StateMachine → StateMachineAccessor

  45. def isEntering(state: State): Bool

    Definition Classes
    StateMachine → StateMachineAccessor

  46. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  47. def isNamed: Boolean

    Definition Classes
    Nameable

  48. def isPriorityApplicable(namePriority: Byte): Boolean

    Definition Classes
    Nameable

  49. def isStateNextBoot(): Bool

    Definition Classes
    StateMachine → StateMachineAccessor

  50. def isStateRegBoot(): Bool

    Definition Classes
    StateMachine → StateMachineAccessor

  51. def isUnnamed: Boolean

    Definition Classes
    Nameable

  52. var name: String

    Attributes
    protected
    Definition Classes
    Nameable

  53. var nameableRef: Nameable

    Attributes
    protected
    Definition Classes
    Nameable

  54. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  55. final def notify(): Unit

    Definition Classes
    AnyRef

  56. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  57. var parentScope: ScopeStatement

    Definition Classes
    ContextUser

  58. var parentStateMachine: StateMachineAccessor

  59. val postBuildTasks: ArrayBuffer[() ⇒ Unit]

  60. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

  61. def reflectNames(): Unit

    Definition Classes
    Area

  62. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StateMachine.this.type

    Definition Classes
    Nameable

  63. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): StateMachine.this.type

    Definition Classes
    Nameable

  64. def setCompositeName(nameable: Nameable, postfix: String): StateMachine.this.type

    Definition Classes
    Nameable

  65. def setCompositeName(nameable: Nameable, namePriority: Byte): StateMachine.this.type

    Definition Classes
    Nameable

  66. def setCompositeName(nameable: Nameable, weak: Boolean): StateMachine.this.type

    Definition Classes
    Nameable

  67. def setCompositeName(nameable: Nameable): StateMachine.this.type

    Definition Classes
    Nameable

  68. def setEncoding(encoding: SpinalEnumEncoding): Unit

  69. def setEntry(state: State): Unit

    Definition Classes
    StateMachine → StateMachineAccessor

  70. def setName(name: String, namePriority: Byte): StateMachine.this.type

    Definition Classes
    Nameable

  71. def setName(name: String, weak: Boolean): StateMachine.this.type

    Definition Classes
    Nameable

  72. def setName(name: String): StateMachine.this.type

    Definition Classes
    Nameable

  73. def setParentStateMachine(parent: StateMachineAccessor): Unit

    Definition Classes
    StateMachine → StateMachineAccessor

  74. def setPartialName(name: String, namePriority: Byte): StateMachine.this.type

    Definition Classes
    Nameable

  75. def setPartialName(name: String, weak: Boolean): StateMachine.this.type

    Definition Classes
    Nameable

  76. def setPartialName(owner: Nameable, name: String, namePriority: Byte): StateMachine.this.type

    Definition Classes
    Nameable

  77. def setPartialName(owner: Nameable, name: String, weak: Boolean): StateMachine.this.type

    Definition Classes
    Nameable

  78. def setPartialName(name: String): StateMachine.this.type

    Definition Classes
    Nameable

  79. def setPartialName(owner: Nameable, name: String): StateMachine.this.type

    Definition Classes
    Nameable

  80. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

  81. def setScalaLocated(source: ScalaLocated): StateMachine.this.type

    Definition Classes
    ScalaLocated

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

    Definition Classes
    Nameable

  83. def startFsm(): Unit

    Definition Classes
    StateMachine → StateMachineAccessor

  84. var stateBoot: State

  85. var stateNext: StateMachineEnum.C

  86. var stateReg: StateMachineEnum.C

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

  88. val states: ArrayBuffer[State]

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

    Definition Classes
    AnyRef

  90. def toString(): String

    Definition Classes
    Area → Nameable → AnyRef → Any

  91. def unsetName(): StateMachine.this.type

    Definition Classes
    Nameable

  92. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  93. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  94. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  95. val wantExit: Bool

    Definition Classes
    StateMachine → StateMachineAccessor

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