sc

README

sc

sc is a Go package for defining, testing, and running statechart-based machines.

See docs/statecharts/v1/statecharts.md for documentation.

See proto/statecharts/v1/statecharts.proto for the type definitions.

Documentation

Overview

Package sc is a Go module for defining, testing, and running statechart-based machines.

Index

• type Action
• type Configuration
• type Event
• type EventHistoryEntry
• type Guard
• type Machine
• type MachineState
• type State
• type StateRef
• type StateType
• type Statechart
• type Transition
• type TransitionHistoryEntry

Types

type Action

type Action = v1.Action

Action defines an action in a Statechart.

type Configuration

type Configuration = v1.Configuration

Configuration defines a configuration in a Statechart.

type Event

type Event = v1.Event

Event defines an event in a Statechart.

type EventHistoryEntry

type EventHistoryEntry = v1.EventHistoryEntry

EventHistoryEntry describes an event that has occurred.

type Guard

type Guard = v1.Guard

Guard defines a guard in a Statechart.

type Machine

type Machine = v1.Machine

Machine describes an instance of a Statechart.

type MachineState

type MachineState = v1.MachineState

MachineState encodes the high-level state of a statechart.

type State

type State = v1.State

State defines a state in a Statechart.

type StateRef

type StateRef = v1.StateRef

StateRef defines a reference to a state in a Statechart.

type StateType

type StateType = v1.StateType

StateType describes the type of a state.

type Statechart

type Statechart = v1.Statechart

Statechart defines a Statechart.

type Transition

type Transition = v1.Transition

Transition defines a transition in a Statechart.

type TransitionHistoryEntry

type TransitionHistoryEntry = v1.TransitionHistoryEntry

TransitionHistoryEntry describes a transition that has been taken.