ConditionalSamplingEventTrigger class Null safety

A trigger that resume and pause sampling when some (other) sampling event occurs and a application-specific condition is meet.

Note that the resumeCondition and pauseCondition are an ConditionalEventEvaluator function which cannot be serialized to/from JSON. In contrast to other Triggers, this trigger cannot be de/serialized from/to JSON. This implies that it can not be retrieved as part of a StudyProtocol from a DeploymentService since it relies on specifying a Dart-specific function as the ConditionalEventEvaluator methods. Hence, this trigger is mostly useful when creating a StudyProtocol directly in the app using Dart code.

If you need to de/serialize an event trigger, use the SamplingEventTrigger instead.

Inheritance
Annotations

Constructors

ConditionalSamplingEventTrigger({required String measureType, ConditionalEventEvaluator? resumeCondition, ConditionalEventEvaluator? pauseCondition})
Create a ConditionalSamplingEventTrigger.
ConditionalSamplingEventTrigger.fromJson(Map<String, dynamic> json)
factory

Properties

$type String?
The runtime class name (type) of this object. Used for deserialization from JSON objects.
read / write, inherited
fromJsonFunction Function
The function which can convert a JSON string to an object of this type.
read-only, override
hashCode int
The hash code for this object. [...]
read-only, inherited
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.
read-only, inherited
measureType String
The data type of the event to look for.
read / write
pauseCondition ConditionalEventEvaluator?
The ConditionalEventEvaluator function evaluating if the event condition is meet for pausing this trigger. [...]
@JsonKey(ignore: true), read / write
requiresMasterDevice bool?
Determines whether the trigger needs to be evaluated on a master device (MasterDeviceDescriptor). For example, this is the case when the trigger is time bound and needs to be evaluated by a task scheduler running on a master device.
@JsonKey(ignore: true), read / write, inherited
resumeCondition ConditionalEventEvaluator?
The ConditionalEventEvaluator function evaluating if the event condition is meet for resuming this trigger
@JsonKey(ignore: true), read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sourceDeviceRoleName String?
The device role name from which the trigger originates.
read / write, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
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