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, 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()

    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
    StateMachine → StateMachineAccessor

  5. def add(state: State): Int

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  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
    StateMachine → StateMachineAccessor

  11. val cache: HashMap[Any, Any]

    Permalink

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

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  13. def cacheGetOrElseUpdate(key: Any, op: ⇒ Any): Any

    Permalink
    Definition Classes
    StateMachineAccessor

  14. def cachePut(key: Any, value: Any): Unit

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  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
    @throws( ... )

  18. def component: Component

    Permalink
    Definition Classes
    ContextUser

  19. def disableAutoStart(): Unit

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  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
    StateMachine → StateMachineAccessor

  26. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef → Any

  29. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  30. def getEntry(): State

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  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
    StateMachine → StateMachineAccessor

  42. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  43. implicit val implicitFsm: StateMachine

    Permalink

  44. var inGeneration: Boolean

    Permalink

  45. def isActive(state: State): Bool

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  46. def isEntering(state: State): Bool

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  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 isStateNextBoot(): Bool

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  51. def isStateRegBoot(): Bool

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  52. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  53. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  54. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  56. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  57. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  58. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  59. var parentStateMachine: StateMachineAccessor

    Permalink

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

    Permalink

  61. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  62. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  69. def setEncoding(encoding: SpinalEnumEncoding): Unit

    Permalink

  70. def setEntry(state: State): Unit

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  74. def setParentStateMachine(parent: StateMachineAccessor): Unit

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  81. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  84. def startFsm(): Unit

    Permalink
    Definition Classes
    StateMachine → StateMachineAccessor

  85. var stateBoot: State

    Permalink

  86. var stateNext: StateMachineEnum.C

    Permalink

  87. var stateReg: StateMachineEnum.C

    Permalink

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

    Permalink

  89. val states: ArrayBuffer[State]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  91. def toString(): String

    Permalink
    Definition Classes
    Area → Nameable → AnyRef → Any

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

    Permalink
    Definition Classes
    Nameable

  93. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  96. val wantExit: Bool

    Permalink
    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