DeviceDescriptor class Null safety
Describes any type of electronic device, such as a smartphone, wearable device, a sensor, or internet service (e.g. FitBit API) that collects data which can be part of a StudyProtocol configuration and which collects measures via probes.
- Inheritance
- Object
- Serializable
- DeviceDescriptor
- Implementers
- Annotations
- @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)
Constructors
-
DeviceDescriptor({required String roleName, bool? isMasterDevice = false, List<
String> ? supportedDataTypes}) -
DeviceDescriptor.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The runtime class name (type) of this object.
Used for deserialization from JSON objects.
read / write, inherited
- fromJsonFunction → Function
-
The function which can convert a JSON string to an object of this type.
read-only, override
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- isMasterDevice ↔ bool?
-
Is this the master device?
read / write
- jsonType → String
-
Return the $type to be used for JSON serialization of this class.
Default is runtimeType. Only specify this if you need another type.
read-only, override
- roleName ↔ String
-
The role name of this device in a specific StudyProtocol.
For example, 'Parent's phone' or 'Child phone'.
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
-
samplingConfiguration
↔ Map<
String, SamplingConfiguration> -
Sampling configurations for data types available on this device which
override the default configuration.
read / write
-
supportedDataTypes
↔ List<
String> ? -
The set of data types which can be collected on this device.
read / write
- type → String
-
The device type identifier
@JsonKey(ignore: true), read-only
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, dynamic> -
Return a JSON encoding of this object.
override
-
toString(
) → String -
A string representation of this object. [...]
override
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
Constants
- DEVICE_NAMESPACE → const String
-
'dk.cachet.carp.protocols.domain.devices'