fsm

README

fsm

finite state machine with dot graph bonus

Running the example

go run cmd/main.go

Input json graph ./example/graph.json

Documentation

Index

• type Action
• type Graph
  • func NewGraph() Graph
  • func (g Graph) AddNode(n *Node) error
  • func (g Graph) GeneratePNG(f io.Writer) error
  • func (g Graph) GetOutcomeStatus(st Status, ac Action) (Status, error)
  • func (g Graph) MarshalJSON() ([]byte, error)
  • func (g Graph) UnmarshalJSON(data []byte) error
  • func (g Graph) Viz() *dot.Graph
• type Node
  • func (n *Node) String() string
• type Status
• type StatusAction

Types

type Action

type Action string

Action represents an action

type Graph

type Graph map[Status]*Node

Graph represent the container of all nodes

func NewGraph

func NewGraph() Graph

NewGraph will create a new Graph

func (Graph) AddNode

func (g Graph) AddNode(n *Node) error

AddNode will add a node to the state graph

func (Graph) GeneratePNG

func (g Graph) GeneratePNG(f io.Writer) error

GeneratePNG will generate a png from the graph dependency on dot

func (Graph) GetOutcomeStatus

func (g Graph) GetOutcomeStatus(st Status, ac Action) (Status, error)

GetOutcomeStatus will return the potential outcomes for a curr status

func (Graph) MarshalJSON

func (g Graph) MarshalJSON() ([]byte, error)

MarshalJSON will return json

func (Graph) UnmarshalJSON

func (g Graph) UnmarshalJSON(data []byte) error

UnmarshalJSON will parse a json into a tree of nodes

func (Graph) Viz

func (g Graph) Viz() *dot.Graph

Viz will create the graphviz graph for the graph

type Node

type Node struct {
	Sources  []StatusAction `json:"sources,omitempty"`
	Status   Status         `json:"status"`
	Outcomes []StatusAction `json:"outcomes,omitempty"`
}

Node represent a Node in the state graph

func (*Node) String

func (n *Node) String() string

type Status

type Status string

Status represent a status

type StatusAction

type StatusAction struct {
	Action Action `json:"action"`
	Status Status `json:"status"`
}

StatusAction represents either an action and its origin state (Source) an action and its state resulting of the action applied (Outcome)