class State extends Area with ScalaLocated

Represents a state within a state machine.

States can define behaviors for entry, exit, and active phases using methods like onEntry, onExit, and whenIsActive.

Example: 

  1. val fsm = new StateMachine {
  val stateA: State = new State with EntryPoint {
    onEntry {
      counter := 0
    }
    whenIsActive {
      counter := counter + 1
      when(counter === 4) {
        goto(stateB)
      }
    }
    onExit {
      io.result := True
    }
  }
  val stateB: State = new State {
    whenIsActive {
      goto(stateA)
    }
  }
}
Linear Supertypes
Area, OverridedEqualsHashCode, ValCallbackRec, ValCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
StateBoot, StateDelay, StateFsm, StateParallelFsm
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. Area
  3. OverridedEqualsHashCode
  4. ValCallbackRec
  5. ValCallback
  6. NameableByComponent
  7. Nameable
  8. ContextUser
  9. ScalaLocated
  10. GlobalDataUser
  11. OwnableRef
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new State()(implicit stateMachineAccessor: StateMachineAccessor)

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. val _context: Capture
    Definition Classes
    Area
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def childNamePriority: Byte
    Definition Classes
    Area
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  8. def component: Component
    Definition Classes
    ContextUser
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  11. def exit(): Unit

    Schedules the state machine to be in the boot state the next cycle (or, in StateFsm, to exit the current nested state machine).

  12. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def getDisplayName(): String
    Definition Classes
    Nameable
  15. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  16. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  17. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  18. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  19. def getPartialName(): String
    Definition Classes
    Nameable
  20. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  21. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  22. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  23. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  24. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  25. def getStateMachineAccessor(): StateMachineAccessor

    Used internally by the state machine library

  26. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  27. def goto(state: State): Unit

    Schedules the state machine to be in the provided State the next cycle.

    Schedules the state machine to be in the provided State the next cycle.

    state

    State to transition to.

    Example: 

    1. val pingState: State = new State with EntryPoint {
  whenIsActive {
    goto(pongState)
  }
}
val pongState: State = new State {
  whenIsActive {
    goto(pingState)
  }
}
  28. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  29. def innerFsm(that: ⇒ StateMachine): Unit

    Internal to the state machine library

  30. var innerFsm: ArrayBuffer[StateMachine]
  31. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def isNamed: Boolean
    Definition Classes
    Nameable
  34. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  35. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  36. val name: String
    Definition Classes
    Nameable
  37. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  41. def onEntry(doThat: ⇒ Unit): State.this.type

    Defines statements to apply when the state machine is not in this state but will be in it during the next cycle.

    Defines statements to apply when the state machine is not in this state but will be in it during the next cycle.

    doThat

    hardware statement(s)

    Example: 

    1. val stateA: State = new State with EntryPoint {
  onEntry {
    counter := 0
    io.led := True
  }
  whenIsActive {
    goto(stateB)
  }
}
  42. val onEntryTasks: ArrayBuffer[() ⇒ Unit]
  43. def onExit(doThat: ⇒ Unit): State.this.type

    Defines statements applied when the state machine is in this state and will be in another state the next cycle.

    Defines statements applied when the state machine is in this state and will be in another state the next cycle.

    doThat

    Hardware statement(s)

    Example: 

    1. val stateA: State = new State with EntryPoint {
  whenIsActive {
    goto(stateB)
  }
  onExit {
    io.result := True
    io.led := False
  }
}
  44. val onExitTasks: ArrayBuffer[() ⇒ Unit]
  45. def overrideLocalName(name: String): State.this.type
    Definition Classes
    Nameable
  46. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  47. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  48. def reflectNames(): Unit
    Definition Classes
    Nameable
  49. def rework[T](body: ⇒ T): T
    Definition Classes
    Area
  50. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  51. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): State.this.type
    Definition Classes
    Nameable
  52. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): State.this.type
    Definition Classes
    Nameable
  53. def setCompositeName(nameable: Nameable, postfix: String): State.this.type
    Definition Classes
    Nameable
  54. def setCompositeName(nameable: Nameable, namePriority: Byte): State.this.type
    Definition Classes
    Nameable
  55. def setCompositeName(nameable: Nameable, weak: Boolean): State.this.type
    Definition Classes
    Nameable
  56. def setCompositeName(nameable: Nameable): State.this.type
    Definition Classes
    Nameable
  57. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): State.this.type
    Definition Classes
    Nameable
  58. def setName(name: String, namePriority: Byte): State.this.type
    Definition Classes
    Nameable
  59. def setName(name: String, weak: Boolean): State.this.type
    Definition Classes
    Nameable
  60. def setName(name: String): State.this.type
    Definition Classes
    Nameable
  61. def setNameAsWeak(): State.this.type
    Definition Classes
    Nameable
  62. def setPartialName(name: String, namePriority: Byte, owner: Any): State.this.type
    Definition Classes
    Nameable
  63. def setPartialName(name: String, namePriority: Byte): State.this.type
    Definition Classes
    Nameable
  64. def setPartialName(name: String, weak: Boolean): State.this.type
    Definition Classes
    Nameable
  65. def setPartialName(owner: Nameable, name: String, namePriority: Byte): State.this.type
    Definition Classes
    Nameable
  66. def setPartialName(owner: Nameable, name: String, weak: Boolean): State.this.type
    Definition Classes
    Nameable
  67. def setPartialName(name: String): State.this.type
    Definition Classes
    Nameable
  68. def setPartialName(owner: Nameable, name: String): State.this.type
    Definition Classes
    Nameable
  69. def setPartialName(owner: Nameable): State.this.type
    Definition Classes
    Nameable
  70. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  71. def setScalaLocated(source: ScalaLocated): State.this.type
    Definition Classes
    ScalaLocated
  72. def setWeakName(name: String): State.this.type
    Definition Classes
    Nameable
  73. val stateId: Int
  74. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  75. def toString(): String
    Definition Classes
    Area → Nameable → AnyRef → Any
  76. def unsetName(): State.this.type
    Definition Classes
    Nameable
  77. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  78. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  79. def valCallbackRec(obj: Any, name: String): Unit
    Definition Classes
    Area → ValCallbackRec
  80. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  82. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. val whenActiveTasks: ArrayBuffer[StateMachineTask]
  84. val whenInactiveTasks: ArrayBuffer[() ⇒ Unit]
  85. def whenIsActive(doThat: ⇒ Unit): State.this.type

    Defines statements applied when the state machine is in this state.

    Defines statements applied when the state machine is in this state.

    doThat

    hardware statement(s)

    Example: 

    1. val stateA: State = new State with EntryPoint {
  whenIsActive {
    counter := counter + 1
    when(counter === 10) {
      goto(stateB)
    }
  }
}
  86. def whenIsActiveWithPriority(priority: Int)(doThat: ⇒ Unit): State.this.type

    Used internally by the state machine library

    Used internally by the state machine library

    See also

    #whenIsActive()

  87. def whenIsInactive(doThat: ⇒ Unit): State.this.type

    Defines statements applied when the state machine is not in this state.

    Defines statements applied when the state machine is not in this state.

    doThat

    hardware statement(s)

  88. def whenIsNext(doThat: ⇒ Unit): State.this.type

    Defines statements applied when the state machine will be in state the next cycle (even if it is already in it).

  89. val whenIsNextTasks: ArrayBuffer[() ⇒ Unit]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

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