actions

Documentation

Index

• func NewEval() *eval
• type ActionEntry
• type ActionHandler
• type ActionListEntry
• type Engine
  • func NewEngine() *Engine
  • func (e *Engine) GetInterface(ifaceId string) *InterfaceEntry
  • func (e *Engine) GetProperties(symbol string) (core.KWArgs, error)
  • func (e *Engine) HasInterface(ifaceId string) bool
  • func (e *Engine) HasSequence(sequencerId string) bool
  • func (e *Engine) InvokeOperation(symbol string, name string, args core.KWArgs) (any, error)
  • func (e *Engine) LoadScenario(doc *ScenarioDoc) error
  • func (e *Engine) PlaySequence(sequencerId string)
  • func (e *Engine) SetProperties(symbol string, props core.KWArgs) error
• type InterfaceEntry
  • func (e InterfaceEntry) GetOperation(name string) *ActionListEntry
• type ScenarioDoc
  • func ReadScenario(fn string) (*ScenarioDoc, error)
  • func (s *ScenarioDoc) GetInterface(name string) *InterfaceEntry
  • func (s *ScenarioDoc) GetSequence(name string) *SequenceEntry
• type SequenceEntry

Functions

func NewEval

func NewEval() *eval

Types

type ActionEntry

type ActionEntry map[string]core.KWArgs

ActionEntry represents an action in an operation or sequence.

type ActionHandler

type ActionHandler func(symbol string, args core.KWArgs, ctx core.KWArgs) (any, error)

type ActionListEntry

type ActionListEntry struct {
	Name        string        `json:"name" yaml:"name"`
	Description string        `json:"description" yaml:"description"`
	Actions     []ActionEntry `json:"actions" yaml:"actions"`
}

ActionListEntry represents a list of actions

type Engine

type Engine struct {
	core.Notifier
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine() *Engine

func (*Engine) GetInterface

func (e *Engine) GetInterface(ifaceId string) *InterfaceEntry

func (*Engine) GetProperties

func (e *Engine) GetProperties(symbol string) (core.KWArgs, error)

FetchProperties returns a copy of the properties of the interface.

func (*Engine) HasInterface

func (e *Engine) HasInterface(ifaceId string) bool

func (*Engine) HasSequence

func (e *Engine) HasSequence(sequencerId string) bool

func (*Engine) InvokeOperation

func (e *Engine) InvokeOperation(symbol string, name string, args core.KWArgs) (any, error)

InvokeOperation invokes a operation of the interface.

func (*Engine) LoadScenario

func (e *Engine) LoadScenario(doc *ScenarioDoc) error

func (*Engine) PlaySequence

func (e *Engine) PlaySequence(sequencerId string)

func (*Engine) SetProperties

func (e *Engine) SetProperties(symbol string, props core.KWArgs) error

SetProperties sets the properties of the interface.

type InterfaceEntry

type InterfaceEntry struct {
	Name        string             `json:"name" yaml:"name"`
	Description string             `json:"description" yaml:"description"`
	Properties  map[string]any     `json:"properties" yaml:"properties"`
	Operations  []*ActionListEntry `json:"operations" yaml:"operations"`
}

InterfaceEntry represents an interface in a scenario.

func (InterfaceEntry) GetOperation

func (e InterfaceEntry) GetOperation(name string) *ActionListEntry

GetOperation returns the operation entry with the given name.

type ScenarioDoc

type ScenarioDoc struct {
	Schema      string            `json:"schema" yaml:"schema"`
	Name        string            `json:"name" yaml:"name"`
	Description string            `json:"description" yaml:"description"`
	Version     string            `json:"version" yaml:"version"`
	Interfaces  []*InterfaceEntry `json:"interfaces" yaml:"interfaces"`
	Sequences   []*SequenceEntry  `json:"sequences" yaml:"sequences"`
}

ScenarioDoc is a scenario document as part of a simulation.

func ReadScenario

func ReadScenario(fn string) (*ScenarioDoc, error)

ReadScenario reads a scenario from file.

func (*ScenarioDoc) GetInterface

func (s *ScenarioDoc) GetInterface(name string) *InterfaceEntry

GetInterface returns the interface entry with the given name.

func (*ScenarioDoc) GetSequence

func (s *ScenarioDoc) GetSequence(name string) *SequenceEntry

GetSequence returns the sequence entry with the given name.

type SequenceEntry

type SequenceEntry struct {
	Name             string             `json:"name" yaml:"name"`
	DefaultInterface string             `json:"interface" yaml:"interface"`
	Description      string             `json:"description" yaml:"description"`
	Interval         int                `json:"interval" yaml:"interval"`
	Repeat           int                `json:"repeat" yaml:"repeat"`
	Steps            []*ActionListEntry `json:"steps" yaml:"steps"`
}

SequenceEntry represents a sequence in a scenario.