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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carp.common

Helper classes and base types relied upon by all subsystems. This library does not contain any domain logic.

The newest version!

package dk.cachet.carp.common.application.triggers

import dk.cachet.carp.common.application.data.NoData
import dk.cachet.carp.common.application.devices.AnyPrimaryDeviceConfiguration
import dk.cachet.carp.common.infrastructure.serialization.DurationSerializer
import kotlinx.serialization.*
import kotlin.js.JsExport
import kotlin.js.JsName
import kotlin.time.Duration


/**
 * A trigger which starts a task after a specified amount of time has elapsed since the start of a study deployment.
 * The start of a study deployment is determined by the first successful deployment of all participating devices.
 * This trigger needs to be evaluated on a primary device since it is time bound and therefore requires a task scheduler.
 */
@Suppress( "DataClassPrivateConstructor" )
@Serializable
@JsExport
data class ElapsedTimeTrigger private constructor(
    override val sourceDeviceRoleName: String,
    @Serializable( DurationSerializer::class )
    val elapsedTime: Duration
) : TriggerConfiguration()
{
    @Transient
    override val requiresPrimaryDevice: Boolean = true

    @JsName( "create" )
    @Suppress( "NON_EXPORTABLE_TYPE" )
    constructor( sourceDevice: AnyPrimaryDeviceConfiguration, elapsedTime: Duration ) :
        this( sourceDevice.roleName, elapsedTime )
}