Study class

The Study holds information about the study to be performed on this device.

A Study specify a set of Triggers, each consisting of a set of Tasks, which again consists of a list of Measures.


A study may be fetched in a StudyManager who knows how to fetch a study protocol for this device. A study is controlled and executed by a StudyController. Data from the study is uploaded to the specified DataEndPoint in the specified dataFormat.



Study(String id, String userId, {String deploymentId, String name, String description, String samplingStrategy, DataEndPoint dataEndPoint, String dataFormat})
Create a new Study object with a set of configurations. [...]
Study.fromJson(Map<String, dynamic> json)


$type String
The runtime class name (type) of this object. Used for deserialization from JSON objects.
read / write, inherited
dataEndPoint DataEndPoint
Specify where and how to upload this study data.
read / write
dataFormat String
The preferred format of the data to be uploaded according to DataFormatType. Default using the NameSpace.CARP.
read / write
deploymentId String
The deployment id of this Study. [...]
read / write
description String
A longer description of this study. To be used to inform the user about this study and its purpose.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
id String
The id of this Study.
read / write
name String
A printer-friendly name for this study.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
samplingStrategy String
The sampling strategy according to SamplingSchemaType.
read / write
tasks List<Task>
The list of all Tasks in this Study.
triggers List<Trigger>
The set of Triggers which can trigger Task in this study.
read / write
userId String
The ID of the user executing this study. May be null if no user is known.
read / write


adapt(SamplingSchema schema, {bool restore = true}) → void
Adapt the sampling Measures of this Study to the specified SamplingSchema.
addTrigger(Trigger trigger) → void
Add a Trigger to this Study
addTriggerTask(Trigger trigger, Task task) → void
Add a Task with a Trigger to this Study
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
registerFromJson(Function fromJsonFunction) → void
Use this method to register a custom fromJson function for this class in the FromJsonFactory.
toJson() Map<String, dynamic>
Return a JSON encoding of this object.
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]

Static Properties

fromJsonFunction Function