runtime

Dec 1, 2023

Changes in this version

type CircuitMetrics

+ InfiniteSignalReadingsTotal *prometheus.CounterVec

Sep 11, 2023

Changes in this version

+ func BackgroundSchedulerModule() fx.Option

+ func BackgroundSchedulerModuleForPolicyApp(circuitAPI CircuitSuperAPI) fx.Option

+ type BackgroundJob interface

+ GetJob func() jobs.Job

+ NotifyCompletion func()

type Circuit

+ func (circuit *Circuit) GetTickInfo() TickInfo

+ func (circuit *Circuit) ScheduleConditionalBackgroundJob(job BackgroundJob, ticksPerExecution int)

type CircuitAPI

+ GetTickInfo func() TickInfo

+ ScheduleConditionalBackgroundJob func(backgroundJob BackgroundJob, ticksPerExecution int)

+ type CircuitSuperAPI interface

+ LockExecution func()

+ RegisterTickEndCallback func(ec TickEndCallback)

+ RegisterTickStartCallback func(sc TickStartCallback)

+ UnlockExecution func()

Aug 3, 2023

Changes in this version

type ConfiguredComponent

+ func NewConfiguredComponent(component Component, config any, componentID ComponentID, ...) (*ConfiguredComponent, error)

May 18, 2023

Changes in this version

type ConstantSignal

+ SpecialValue string

May 15, 2023

Changes in this version

+ const NestedComponentDelimiter

+ const RootComponentID

+ const SignalTypeConstant

+ const SignalTypeNamed

+ func CircuitModule() fx.Option

+ func Compile(configuredComponents []*ConfiguredComponent, logger *log.Logger) error

+ type Circuit struct

+ func NewCircuitAndOptions(configuredComponents []*ConfiguredComponent, policyReadAPI iface.Policy) (*Circuit, fx.Option)

+ func (circuit *Circuit) DynamicConfigUpdate(event notifiers.Event, unmarshaller config.Unmarshaller)

+ func (circuit *Circuit) Execute(tickInfo TickInfo) error

+ func (circuit *Circuit) LockExecution()

+ func (circuit *Circuit) RegisterTickEndCallback(ec TickEndCallback)

+ func (circuit *Circuit) RegisterTickStartCallback(sc TickStartCallback)

+ func (circuit *Circuit) UnlockExecution()

+ type CircuitAPI interface

+ LockExecution func()

+ RegisterTickEndCallback func(ec TickEndCallback)

+ RegisterTickStartCallback func(sc TickStartCallback)

+ UnlockExecution func()

+ type CircuitMetrics struct

+ InvalidSignalReadingsTotal *prometheus.CounterVec

+ SignalSummaryVec *prometheus.SummaryVec

+ type Component interface

+ DynamicConfigUpdate func(event notifiers.Event, unmarshaller config.Unmarshaller)

+ Execute func(inPortReadings PortToReading, tickInfo TickInfo) (outPortReadings PortToReading, err error)

+ IsActuator func() bool

+ Name func() string

+ ShortDescription func() string

+ Type func() ComponentType

+ func NewDummyComponent(name, shortDescription string, componentType ComponentType) Component

+ type ComponentID interface

+ ChildID func(id string) ComponentID

+ ParentID func() (ComponentID, bool)

+ String func() string

+ func NewComponentID(id string) ComponentID

+ type ComponentType string

+ const ComponentTypeSignalProcessor

+ const ComponentTypeSink

+ const ComponentTypeSource

+ const ComponentTypeStandAlone

+ type ConfiguredComponent struct

+ ComponentID ComponentID

+ Config utils.MapStruct

+ PortMapping PortMapping

+ type ConstantSignal struct

+ Value float64

+ func ConstantSignalFromProto(constantSignalProto *policylangv1.ConstantSignal) *ConstantSignal

+ func (constantSignal *ConstantSignal) Description() string

+ func (constantSignal *ConstantSignal) Float() float64

+ func (constantSignal *ConstantSignal) IsSpecial() bool

+ type PortMapping struct

+ Ins PortToSignals

+ Outs PortToSignals

+ func NewPortMapping() PortMapping

+ func PortsFromComponentConfig(componentConfig utils.MapStruct, subCircuitID string) (PortMapping, error)

+ func (p *PortMapping) AddInPort(portName string, signals []Signal)

+ func (p *PortMapping) AddOutPort(portName string, signals []Signal)

+ func (p *PortMapping) GetInPort(portName string) ([]Signal, bool)

+ func (p *PortMapping) GetOutPort(portName string) ([]Signal, bool)

+ func (p *PortMapping) Merge(other PortMapping) error

+ type PortToReading map[string][]Reading

+ func (ptr PortToReading) ReadRepeatedReadingPort(portName string) []Reading

+ func (ptr PortToReading) ReadSingleReadingPort(portName string) Reading

+ type PortToSignals map[string][]Signal

+ type Reading interface

+ Valid func() bool

+ Value func() float64

+ func InvalidReading() Reading

+ func NewBoolReading(value bool) Reading

+ func NewReading(value float64) Reading

+ type Signal struct

+ ConstantSignal ConstantSignal

+ Looped bool

+ SignalName string

+ SubCircuitID string

+ func (s *Signal) ConstantSignalValue() float64

+ func (s *Signal) SignalID() SignalID

+ func (s *Signal) SignalType() SignalType

+ type SignalID struct

+ SignalName string

+ SubCircuitID string

+ func MakeRootSignalID(signalName string) SignalID

+ type SignalType int

+ type TickEndCallback func(tickInfo TickInfo) error

+ type TickInfo interface

+ Interval func() time.Duration

+ Serialize func() *policysyncv1.TickInfo

+ String func() string

+ Tick func() int

+ Timestamp func() time.Time

+ func NewTickInfo(timestamp time.Time, tick int, interval time.Duration) TickInfo

+ type TickStartCallback func(tickInfo TickInfo) error