sim

Documentation

Index

• Constants
• Variables
• func NewServer() *server
• type APIEvent
• type APIEventType
• type ErrorEvent
• type ProgramEvent
• type ProgramEventType
• type Simulation
  • func NewSimulation() *Simulation
  • func (s *Simulation) LoadScenario(source string, doc *spec.ScenarioDoc) error
  • func (s *Simulation) LoadScript(source string, script string) error
  • func (s *Simulation) Stop()
  • func (s *Simulation) UnloadScenario(source string) error

Constants

const (
	EventSimulationStart ProgramEventType = "simulation.start"
	EventSimulationStop  ProgramEventType = "simulation.stop"
	EventCall            APIEventType     = "call"
	EventResponse        APIEventType     = "response"
	EventSignal          APIEventType     = "signal"
	EventPropertySet     APIEventType     = "property.set"
	EventPropertyChanged APIEventType     = "property.changed"
)

Variables

var ApiEventEmitter = make(chan APIEvent)

var ErrorEventEmitter = make(chan ErrorEvent)

var ProgramEventEmitter = make(chan ProgramEvent)

Functions

func NewServer

func NewServer() *server

Types

type APIEvent

type APIEvent struct {
	Type   APIEventType   `json:"type"`
	Symbol string         `json:"symbol"`
	Params []any          `json:"params"`
	Props  map[string]any `json:"props"`
	Error  error          `json:"error"`
}

type APIEventType

type APIEventType string

type ErrorEvent

type ErrorEvent struct {
	Error   error  `json:"error"`
	Message string `json:"message"`
}

type ProgramEvent

type ProgramEvent struct {
	Type    APIEventType `json:"type"`
	Message string       `json:"message"`
}

type ProgramEventType

type ProgramEventType string

type Simulation

type Simulation struct {
	*core.MultiEngine
	// contains filtered or unexported fields
}

Simulate runs one or more simulation scenarios. To unload a scenario call the Stop operation with the scenario name. To stop all scenarios call the StopAll operation. A scenario can simulation properties, operations and signals using static values or scripted behavior. The scripted behavior can be either triggered by a call or by a script entry All results are send out via the event channel.

func NewSimulation

func NewSimulation() *Simulation

func (*Simulation) LoadScenario

func (s *Simulation) LoadScenario(source string, doc *spec.ScenarioDoc) error

func (*Simulation) LoadScript

func (s *Simulation) LoadScript(source string, script string) error

func (*Simulation) Stop

func (s *Simulation) Stop()

func (*Simulation) UnloadScenario

func (s *Simulation) UnloadScenario(source string) error