commonMain.dk.cachet.carp.common.application.devices.PrimaryDeviceConfiguration.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!

@file:Suppress( "NON_EXPORTABLE_TYPE" )

package dk.cachet.carp.common.application.devices

import dk.cachet.carp.common.application.triggers.ElapsedTimeTrigger
import kotlinx.serialization.*
import kotlin.contracts.ExperimentalContracts
import kotlin.contracts.contract
import kotlin.js.JsExport
import kotlin.time.Duration


/**
 * A device which aggregates, synchronizes, and optionally uploads incoming data received from one or more connected devices (potentially just itself).
 * Typically, a desktop computer, smartphone, or web server.
 */
@Serializable
@Polymorphic
@JsExport
abstract class PrimaryDeviceConfiguration<
    TRegistration : DeviceRegistration,
    out TBuilder : DeviceRegistrationBuilder
> : DeviceConfiguration()
{
    // This property is only here for (de)serialization purposes.
    // For unknown types we need to know whether to treat them as primary devices or not (in the case of 'DeviceConfiguration' collections).
    @Required
    internal val isPrimaryDevice: Boolean = true

    /**
     * Get a trigger which fires immediately at the start of a study deployment.
     */
    fun atStartOfStudy(): ElapsedTimeTrigger = ElapsedTimeTrigger( this, Duration.ZERO )
}

typealias AnyPrimaryDeviceConfiguration = PrimaryDeviceConfiguration<*, *>


/**
 * Determines whether this device configuration is a primary device configuration ([AnyPrimaryDeviceConfiguration]).
 */
@OptIn( ExperimentalContracts::class )
@JsExport
fun AnyDeviceConfiguration.isPrimary(): Boolean
{
    contract {
        returns( true ) implies( this@isPrimary is AnyPrimaryDeviceConfiguration )
    }
    return this is AnyPrimaryDeviceConfiguration
}