commonMain.dk.cachet.carp.common.application.triggers.Trigger.kt Maven / Gradle / Ivy

Go to download
package dk.cachet.carp.common.application.triggers

import dk.cachet.carp.common.application.Immutable
import dk.cachet.carp.common.application.ImplementAsDataClass
import dk.cachet.carp.common.application.data.Data
import dk.cachet.carp.common.application.devices.DeviceDescriptor
import dk.cachet.carp.common.application.devices.MasterDeviceDescriptor
import kotlinx.serialization.Polymorphic
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient


/**
 * Any condition on a device ([DeviceDescriptor]) used to start or stop tasks at certain points in time when the condition applies.
 * The condition can either be time-bound, based on data streams, initiated by a user of the platform, or a combination of these.
 */
@Serializable
@Polymorphic
@Immutable
@ImplementAsDataClass
abstract class Trigger
{
    /**
     * Determines whether the trigger needs to be evaluated on a master device ([MasterDeviceDescriptor]).
     * For example, this is the case when the trigger is time bound and needs to be evaluated by a task scheduler running on a master device.
     */
    @Transient
    open val requiresMasterDevice: Boolean = false

    /**
     * The device role name from which the trigger originates.
     */
    abstract val sourceDeviceRoleName: String
}