StudyDeployment class

A single instantiation of a StudyProtocol, taking care of common concerns related to devices when 'running' a study.

I.e., a StudyDeployment is responsible for registering the physical devices described in the StudyProtocol, enabling a connection between them, tracking device connection issues, and assessing data quality.

Constructors

StudyDeployment(StudyProtocol protocol, [String? studyDeploymentId])
Create a new StudyDeployment based on a StudyProtocol. studyDeploymentId specify the study deployment id. If not specified, an UUID v1 id is generated.

Properties

creationDate → DateTime
no setter
deployedDevices → Set<String?>
The set of devices (role names) which have been deployed correctly.
no setter
deviceRegistrationHistory → Map<DeviceDescriptor, List<DeviceRegistration>>
Per device, a list of all device registrations (included old registrations) in the order they were registered.
no setter
hashCode → int
The hash code for this object.
no setterinherited
invalidatedDeployedDevices → Set<DeviceDescriptor>
no setter
isStopped → bool
Determines whether the study deployment has been stopped and no further modifications are allowed.
no setter
protocol → StudyProtocol
no setter
registeredDevices → Map<DeviceDescriptor, DeviceRegistration>
The set of devices which are currently registered for this study deployment.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startTime → DateTime?
The time when the study deployment was ready for the first time (all devices deployed); null otherwise.
no setter
status → StudyDeploymentStatus
Get the status of this StudyDeployment.
no setter
studyDeploymentId → String
no setter

Methods

deviceDeployed(MasterDeviceDescriptor device, DateTime deviceDeploymentLastUpdateDate) → void
Indicate that the specified master device was deployed successfully using the deployment with the specified deviceDeploymentLastUpdateDate.
getDeviceDeploymentFor(MasterDeviceDescriptor device) → MasterDeviceDeployment
Get the deployment configuration for the specified master device in this study deployment.
getDeviceStatus(DeviceDescriptor device) → DeviceDeploymentStatus
Get the status of a device in this StudyDeployment.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerDevice(DeviceDescriptor device, DeviceRegistration registration) → void
Register the specified device for this deployment using the registration options.
stop() → void
Stop this study deployment. No further changes to this deployment are allowed and no more data should be collected.
toString() → String
A string representation of this object.
inherited
unregisterDevice(DeviceDescriptor device) → void
Remove the current device registration for the device in this deployment.

Operators

operator ==(Object other) → bool
The equality operator.
inherited