BufferingPeriodicProbe class abstract

An type of probe which collects data for a period of time and then return a measurement from this collected data.

Probes of this type uses a PeriodicSamplingConfiguration that specify the interval of starting sampling, and the duration of the sampling window. Once this sampling window is over, the final measurement is collected from the getMeasurement method and send to the main measurements stream.

When sampling starts, the onSamplingStart handle is called. When the sampling window ends, the onSamplingEnd handle is called.

Inheritance

• Object
• AbstractExecutor<Measure>
• Probe
• MeasurementProbe
• BufferingPeriodicProbe

Constructors

BufferingPeriodicProbe()

Properties

configuration → Measure?

The configuration of this executor as set in initialize.

no setter, inherited

deployment → SmartphoneDeployment?

The deployment that this executor is part of executing.

no setter, inherited

deviceManager ↔ DeviceManager<DeviceConfiguration<DeviceRegistration>, DeviceRegistration>

The device that this probes uses to collect data.

getter/setter pair, inherited

enabled ↔ bool

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

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

measure → Measure?

The Measure that configures this probe.

no setter, inherited

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, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

samplingConfiguration → PeriodicSamplingConfiguration?

The sampling configuration for this probe.

no setter, override

samplingState → SamplingState

The runtime sampling state of this executor.

no setter, inherited

state → ExecutorState

The runtime state of this executor.

no setter, inherited

stateEvents → Stream<ExecutorState>

The runtime state changes of this executor.

no setter, inherited

timer ↔ Timer?

getter/setter pair

type → String?

The data type this probe is collecting.

no setter, inherited

Methods

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

Add error to the measurements stream.

inherited

addMeasurement(Measurement measurement) → void

Add measurement to the measurements stream.

inherited

arePermissionsGranted() → Future<bool>

Does this probe has the permissions needed to run?

inherited

dispose() → void

Dispose of this executor.

inherited

error() → void

inherited

getMeasurement() → Future<Measurement?>

Subclasses should implement / override this method to collect the Measurement. This method will be called every time data has been buffered for a duration and should return the final Measurement for the buffered data.

override

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

Configure and initialize the executor before using 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.

inherited

onPause() → Future<bool>

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

override

onResume() → Future<bool>

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

override

onSamplingEnd() → void

Handler called when sampling period ends.

onSamplingStart() → void

Handler called when sampling period starts.

pause() → void

Pause the executor. Paused until resume is called.

inherited

pauseButShouldBeResumed() → void

Pause the executor but mark it to be resumed when possible.

inherited

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.

inherited

resume() → void

Resume the executor.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited