BackgroundTask class
A task which specifies that all containing measures and/or outputs should immediately start running in the background once triggered. The task runs for the specified duration, or until stopped, or until all measures and/or outputs have completed.
- Inheritance
-
- Object
- Serializable
- TaskDescriptor
- BackgroundTask
- Annotations
-
- @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)
Constructors
-
BackgroundTask.new({String? name, List<
Measure> ? measures, Duration? duration}) - Create a new task which can run in the background.
-
BackgroundTask.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
- duration ↔ Duration?
-
The optional duration over the course of which the measures need to
be sampled.
null
implies infinite by default.getter/setter pair - 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
__type
to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.no setterinherited -
measures
↔ List<
Measure> -
A list of Measures to be done as part of this task.
getter/setter pairinherited
- name ↔ String
-
The name of this task. Unique for this StudyProtocol.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addMeasure(
Measure measure) → void -
Add a Measure to this task.
inherited
-
addMeasures(
Iterable< Measure> list) → void -
Add a list of Measures to this task.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeMeasure(
Measure measure) → void -
Remove a Measure from this task.
inherited
-
toJson(
) → Map< String, dynamic> -
Return a JSON encoding of this object.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited