ClientManager class - carp_core_client library

Constructors

deploymentService ↔ DeploymentService?: The application service through which study deployments, to be run on this client, can be managed and retrieved.
getter/setter pair
deviceController ↔ DeviceDataCollectorFactory?: The controller of connected devices used to collect data locally on this master device. Also works as a factory which is used to create DeviceDataCollector instances for connected devices.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
isConfigured → bool: Determines whether a DeviceRegistration has been configured for this client, which is necessary to start adding StudyRuntimes.
no setter
registration ↔ DeviceRegistration?: The registration of this client device.
getter/setter pair
repository ↔ Map<Study, StudyRuntime>: Repository within which the state of this client is stored.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

addStudy(Study study) → Future<StudyStatus>: Add a study which needs to be executed on this client. This involves registering this device for the specified study deployment.
configure({required DeploymentService deploymentService, required DeviceDataCollectorFactory deviceController, required String? deviceId}) → Future<DeviceRegistration>: Configure this ClientManager by specifying:
getStudyRuntime(Study study) → StudyRuntime?: Get the StudyRuntime for a study.
getStudyStatusList() → List<StudyStatus>: Get the status for the studies which run on this client device.
lookupStudyRuntime(String studyDeploymentId, String deviceRoleName) → StudyRuntime?: Lookup the StudyRuntime based on the studyDeploymentId and deviceRoleName.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeStudy(Study study) → Future<void>: Remove study from this client manager.
stopStudy(Study study) → Future<void>: Permanently stop collecting data for study and then remove it.
toString() → String: A string representation of this object.
inherited
tryDeployment(Study study) → Future<StudyStatus>: Verifies whether the device is ready for deployment of the study runtime identified by study, and in case it is, deploys. In case already deployed, nothing happens.