dsl

Documentation

Index

• type Action
• type Datatype
• type Event
• type MissionData

Types

type Action

type Action interface {
	// Execute performs an action until it is complete or it
	// encounters an error.
	Execute(sdk.Vehicle, MissionData) error
}

Action holds an action type that can be used as a state in the mission FSM.

type Datatype

type Datatype interface {
	// Type is a blank function that is only used to make a struct as a DSL datatype. Any
	// struct that implements this function will be found by the package loader.
	Type()
}

Datatype holds a type that is used in an Event or an Action.

type Event

type Event interface {
	// Monitor continues to check for an event state until it
	// occurs or encounters an error.
	Monitor(sdk.Vehicle, MissionData) (bool, error)
}

Event holds an event type that can be used as a transition function in the mission FSM.

type MissionData

type MissionData struct {
	Cap  sdk.CapFile    // cap corresponding to this device
	Map  geo.Map        // mission map initialized from GeoJSON (optional)
	Role swarm.Role     // role in the current mission
	Log  zerolog.Logger // logger for this mission
}

MissionData holds extra data that is useful for DSL tasks.