StudyRuntime class abstract
Manage data collection for a specific master device deployment on a client device.
Constructors
- StudyRuntime.new(DeploymentService deploymentService, DeviceDataCollectorFactory deviceRegistry)
-
Create a new study runtime, specifying the
deploymentServiceto use to retrieve and manage the study deployment with studyDeploymentId and thedeviceRegistryto handle the devices used in this study deployment.
Properties
- deployment ↔ MasterDeviceDeployment?
-
The MasterDeviceDeployment for this study runtime.
getter/setter pair
- deploymentService ↔ DeploymentService
-
The deployment service to use to retrieve and manage the study deployment.
Use the initialize method to initialize this service.
getter/setter pair
- deploymentStatus ↔ StudyDeploymentStatus
-
The latest known deployment status.
getter/setter pair
- device ↔ MasterDeviceDescriptor?
-
The description of the device this runtime is intended for within the
deployment identified by studyDeploymentId.
getter/setter pair
- deviceRegistry ↔ DeviceDataCollectorFactory
-
The device registry that handles the devices used in this runtime.
getter/setter pair
- deviceRoleName → String?
-
The device role name.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isDeployed → bool
-
Has the device deployment been completed successfully?
no setter
- isInitialized → bool
-
Has this StudyRuntime been initialized?
no setter
- isStopped → bool
-
Has the study and data collection been stopped?
no setter
-
remainingDevicesToRegister
→ List<
DeviceDescriptor> -
The list of devices that still remain to be registered before all devices
in this study runtime is registered.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status ↔ StudyStatus
-
The status of this StudyRuntime.
getter/setter pair
-
statusEvents
→ Stream<
StudyStatus> -
The stream of StudyStatus events for this controller.
no setter
- study → Study?
-
The study for this study runtime.
no setter
- studyDeploymentId → String?
-
The study deployment id for the study of this controller.
no setter
Methods
-
dispose(
) → void - Called when this StudyRuntime is disposed. This entails stopping and disposing all data sampling and storage.
-
initialize(
Study study, DeviceRegistration deviceRegistration) → Future< void> -
Initialize this study runtime by specifying its
studyanddeviceRegistration. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → void - Pause the collection of data for this StudyRuntime.
-
remove(
) → Future< void> - Called when this StudyRuntime is removed from a ClientManager.
-
start(
) → void - Start collecting data for this StudyRuntime.
-
stop(
) → Future< void> - Permanently stop collecting data for this StudyRuntime.
-
toString(
) → String -
A string representation of this object.
inherited
-
tryDeployment(
) → Future< StudyStatus> - Verifies whether the master device is ready for deployment and in case it is, deploy the study previously added. Deployment entails trying to retrieve the deployment from the deploymentService, based on the studyDeploymentId.
-
tryRegisterConnectedDevice(
DeviceDescriptor device) → Future< void> - Tries to register a connected device which are available in this device's deviceRegistry as well as in the deploymentService.
-
tryRegisterConnectedDevices(
) → Future< void> - Tries to register all connected devices which are available in this device's deviceRegistry as well as in the deploymentService.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited