PrimaryDevice<TRegistration extends DeviceRegistration> class
abstract
Base class for CAMS primary device configurations.
A primary device runs the study and collects data from connected devices. Smartphone is the built-in one; extend this class to define other types of primary devices supported by different CAMS apps (see issue #546).
- Inheritance
-
- Object
- Serializable
- DeviceConfiguration<
TRegistration> - PrimaryDeviceConfiguration<
TRegistration> - PrimaryDevice
- Implementers
Constructors
- PrimaryDevice({required String roleName})
Properties
- $type ↔ String?
-
The type name written to
__typein JSON; set tojsonTypeon creation.getter/setter pairinherited - atStartOfStudy → TriggerConfiguration
-
A new trigger which fires immediately at the start of a study deployment
on this device.
no setterinherited
- dataTypeSamplingSchemes → DataTypeSamplingSchemeMap?
-
Sampling schemes for all the sensors available on this device.
no setterinherited
-
defaultSamplingConfiguration
↔ Map<
String, SamplingConfiguration> ? -
Sampling configurations which override the default configurations for
data types available on this device, mapped by data type.
getter/setter pairinherited
- fromJsonFunction → Function
-
The generated function that converts a JSON map to an object of this type.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isOptional ↔ bool?
-
Determines whether device registration for this device is optional prior to
starting a study, i.e., whether the study can run without this device or not.
getter/setter pairinherited
- isPrimaryDevice ↔ bool
-
Defaults to true. Only here for (de)serialization: for unknown device
types, the JSON tells whether to treat them as primary devices.
getter/setter pairinherited
- jsonType → String
-
The
__typeused for JSON serialization of this class.no setteroverride - roleName ↔ String
-
A name which describes how the device participates within the study protocol;
its 'role'. For example, 'Parent's phone' or 'Child phone'.
Must be unique within a protocol.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
supportedDataTypes
→ Set<
String> ? -
The set of data types which can be collected on this device.
no setterinherited
- type → String
-
The device type identifier, i.e. its
jsonType.no setterinherited
Methods
-
acceptedRegistration(
DeviceRegistration registration) → DeviceRegistration -
The
registrationin the form the deployment service accepts for this device.inherited -
createRegistration(
{String? deviceId, String? deviceDisplayName}) → TRegistration -
Create a
DeviceRegistrationwhich can be used to configure this device for deployment.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON map of this object, including the
__typeproperty.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited