core/it.unibo.pulvreakt.dsl.model

Package-level declarations

Types

Capability

sealed interface Capability

Express a capacity that a Component requires to be executed.

ComponentsGraph

typealias ComponentsGraph = Map<ComponentRef, Set<ComponentRef>>

ComponentStartupHost

typealias ComponentStartupHost = Map<Component, Host>

ConfiguredDevicesRuntimeConfiguration

typealias ConfiguredDevicesRuntimeConfiguration = NonEmptySet<DeviceRuntimeConfiguration>

ConfiguredDeviceStructure

typealias ConfiguredDeviceStructure = NonEmptySet<DeviceStructure>

DeviceReconfigurationRule

data class DeviceReconfigurationRule(val event: ReconfigurationEvent<*>, val newConfiguration: NewConfiguration)

Models a reconfiguration rule for a device. The event triggers the newConfiguration of the device.

DeviceRuntimeConfiguration

data class DeviceRuntimeConfiguration( val deviceName: String, val componentStartupHost: ComponentStartupHost, val reconfigurationRules: ReconfigurationRules?)

Models the runtime configuration of a device. deviceName is the name of the device. componentStartupHost is the map that associates a component to the host on which it is started. reconfigurationRules are the reconfiguration rules of the device.

DevicesConfiguration

typealias DevicesConfiguration = Map<String, DeviceSpecification>

DeviceSpecification

data class DeviceSpecification( val deviceName: String, val componentsConfiguration: ComponentsGraph, val requiredCapabilities: RequiredCapabilities, val runtimeConfiguration: DeviceRuntimeConfiguration)

Represents the device specification. It is characterized by a deviceName, a componentsConfiguration that describes the links between the components of the device, the requiredCapabilities of each component, and the runtimeConfiguration of the device.

DeviceStructure

data class DeviceStructure(val deviceName: String, val componentsGraph: ComponentsGraph, val requiredCapabilities: RequiredCapabilities)

Represents the structure of a device characterized by a deviceName, a componentsGraph that describes the links between the components of the device, and the requiredCapabilities of each component.

NewConfiguration

data class NewConfiguration(val component: ComponentRef, val destinationHost: Host)

Models a new configuration in the system. The component is moved to the destinationHost.

OnDeviceRules

typealias OnDeviceRules = Set<DeviceReconfigurationRule>

PulvreaktConfiguration

data class PulvreaktConfiguration(val devicesConfiguration: DevicesConfiguration, val protocol: Protocol)

Represents the container of configurations and additional information for the communication. devicesConfiguration is the map that associates a device name to its specification. protocol is the Protocol that will be used for the communication.

ReconfigurationRules

data class ReconfigurationRules(val onDeviceRules: OnDeviceRules?)

Models the reconfiguration rules of the device. onDeviceRules are the rules that are triggered by events that occur on the device. onDeviceRules will be null if no reconfiguration rules are specified for the device.

RequiredCapabilities

typealias RequiredCapabilities = Map<ComponentRef, NonEmptySet<Capability>>

Functions

get

operator fun ConfiguredDeviceStructure.get(deviceName: String): DeviceStructure?

Extension function to get a DeviceStructure from a ConfiguredDeviceStructure by its deviceName.