commonMain.dk.cachet.carp.common.application.tasks.CustomProtocolTask.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.NoData
import kotlinx.serialization.*
import kotlin.js.JsExport


/**
 * A [TaskConfiguration] which contains a definition on how to run tasks, measures, and triggers which differs from the CARP domain model.
 */
@Serializable
@JsExport
data class CustomProtocolTask(
    override val name: String,
    /**
     * A definition on how to run a study on a primary device, serialized as a string.
     */
    val studyProtocol: String
) : TaskConfiguration
{
    /**
     * Description is empty, since it is likely defined in [studyProtocol] in a different format.
     */
    override val description: String? = null

    /**
     * This list is empty, since measures are defined in [studyProtocol] in a different format.
     */
    @Suppress( "NON_EXPORTABLE_TYPE" )
    override val measures: List = emptyList()
}