commonMain.dk.cachet.carp.common.application.tasks.Measure.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.tasks

import dk.cachet.carp.common.application.data.DataType
import dk.cachet.carp.common.application.devices.DeviceConfiguration
import dk.cachet.carp.common.application.sampling.SamplingConfiguration
import kotlinx.serialization.*
import kotlin.js.JsExport


/**
 * Defines data that needs to be measured/collected passively as part of a task defined by [TaskConfiguration].
 */
@Serializable
@JsExport
sealed class Measure
{
    /**
     * Defines data that needs to be measured/collected from a data stream on a [DeviceConfiguration].
     */
    @Serializable
    data class DataStream(
        /**
         * The type of data this measure collects.
         */
        val type: DataType,
        /**
         * Optionally, override the default configuration on how to sample the data stream of the matching [type] on the device.
         * In case `null` is specified, the default configuration is derived from the [DeviceConfiguration].
         */
        val overrideSamplingConfiguration: SamplingConfiguration? = null
    ) : Measure()

    /**
     * Specify that the data related to the trigger with [triggerId] which started or stopped the task should be measured.
     */
    @Serializable
    data class TriggerData( val triggerId: Int ) : Measure()
}