CustomProtocolTask class
A task which contains a definition of a custom protocol which differs from the CARP domain model.
- Inheritance
-
- Object
- Serializable
- TaskConfiguration
- CustomProtocolTask
- Annotations
-
- @JsonSerializable(includeIfNull: false, explicitToJson: true)
Constructors
- CustomProtocolTask({String? name, String? description, required String studyProtocol})
-
Create a task which is used in a custom protocol, specified as a
string in
studyProtocol. -
CustomProtocolTask.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The runtime class name (type) of this object.
Used for deserialization from JSON objects.
getter/setter pairinherited
- description ↔ String?
-
A description of this task, emphasizing the reason why the data is collected.
getter/setter pairinherited
- fromJsonFunction → Function
-
The function which can convert a JSON string to an object of this type.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- jsonType → String
-
Return the
__typeto be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.no setterinherited -
measures
↔ List<
Measure> ? -
The data which needs to be collected/measured passively as part of this task.
getter/setter pairinherited
- name ↔ String
-
A name which uniquely identifies the task.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- studyProtocol ↔ String
-
A definition on how to run a study on a primary device, serialized as a string.
getter/setter pair
Methods
-
addMeasure(
Measure measure) → void -
Add
measureto this task.inherited -
addMeasures(
Iterable< Measure> list) → void -
Add a
listof measures to this task.inherited -
getAllExpectedDataTypes(
) → Set< String> -
Get data types of all data which may be collected, either passively as part
of task measures, or as the result of user interactions, for this task.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeMeasure(
Measure measure) → void -
Remove
measurefrom this task.inherited -
toJson(
) → Map< String, dynamic> -
Return a JSON encoding of this object.
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited