planner

Documentation

Index

• type Action
• type Planner

Types

type Action

type Action struct {
	Name       string
	Properties interface{}
}

Action holds information for a particular action.

type Planner

type Planner interface {
	// CreatePlan creates a plan based on the given current and desired state.
	CreatePlan(current common.State, desired common.State, profiles map[string]common.Profile) []Action
	// ExecutePlan triggers the planner to actually perform the Plan.
	ExecutePlan(common.State, []Action)
	// TriggerEffect triggers all actuators planning actuators to (optionally) reflect on the effect of their actions.
	TriggerEffect(current common.State, profiles map[string]common.Profile)
}

Planner represents the basic interface all planners should adhere too.