Probe class abstract

A Probe is a specialized Executor responsible for collecting data from the device sensors as configured in a Measure.

A probe may need a set of permissions to run. Following best practice on both Android and iOS a probe will ask for permission when started using the requestPermissions method.

Inheritance

• Object
• AbstractExecutor<Measure>
• Probe

Implementers

• MeasurementProbe
• StreamProbe
• StubProbe

Constructors

Probe()

Properties

configuration → Measure?

The configuration of this executor as set when initialized.

no setter, inherited

deployment → SmartphoneDeployment?

The deployment that this executor is part of executing.

no setter, inherited

deviceManager ↔ DeviceManager<DeviceConfiguration<DeviceRegistration>>

The device that this probes uses to collect data.

getter/setter pair

enabled ↔ bool

Is this probe enabled, i.e. available for collection of data using the start method.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isStarting → bool

Is this executor in the process of being started?

no setter, inherited

measure → Measure?

The Measure that configures this probe.

no setter

measurements → Stream<Measurement>

The stream of Measurement collected by this executor.

no setter, inherited

permissions → List<Permission>

The list of permissions needed for this probe.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

samplingConfiguration → SamplingConfiguration?

The sampling configuration for this probe.

no setter

state → ExecutorState

The runtime state of this executor.

no setter, inherited

stateEvents → Stream<ExecutorState>

The runtime state changes of this executor.

no setter, inherited

type → String?

The data type this probe is collecting.

no setter

Methods

addError(Object error, [StackTrace? stacktrace]) → void

Add error to the measurements stream.

inherited

addMeasurement(Measurement measurement) → void

Add measurement to the measurements stream.

override

arePermissionsGranted() → Future<bool>

Does this probe has the permissions needed to run?

dispose() → void

Dispose of this executor.

inherited

error() → void

inherited

initialize(Measure configuration, [SmartphoneDeployment? deployment]) → void

Configure and initialize the executor before starting it.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDispose() → Future<void>

Callback when this executor is disposed.

inherited

onInitialize() → bool

Callback when this executor is initialized. Returns true if successfully initialized, false otherwise.

override

onRestart() → Future<bool>

Callback when this executor is to be restarted. Returns true if the executor is ready to restart (default), false otherwise.

inherited

onStart() → Future<bool>

Callback when this executor is started. Returns true if successfully started, false otherwise.

override

onStop() → Future<bool>

Callback when this executor is stopped. Returns true if successfully stopped, false otherwise.

override

requestPermissions() → Future<bool>

Request the permissions needed for this probe to run. Return true if all permissions are granted. Only used on Android - iOS automatically request permissions when a resource (like the microphone) is accessed.

restart() → void

Restart the executor.

inherited

start() → void

Start the executor.

inherited

stop() → void

Stop the executor. Stopped until start or restart is called.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited