CustomProtocolDevice class Null safety
A general-purpose master device for custom protols. Only used when downloading custom protocols from the CARP web service.
- Inheritance
- Object
- Serializable
- DeviceDescriptor
- MasterDeviceDescriptor
- CustomProtocolDevice
- Annotations
- @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)
Constructors
-
CustomProtocolDevice({String? roleName, List<
String> ? supportedDataTypes}) -
Create a new CustomProtocolDevice device descriptor.
If
roleName
is not specified, then the DEFAULT_ROLENAME is used. -
CustomProtocolDevice.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, inherited
- 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, inherited
- roleName ↔ String
-
The role name of this device in a specific StudyProtocol.
For example, 'Parent's phone' or 'Child phone'.
read / write, inherited
- 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, inherited
-
supportedDataTypes
↔ List<
String> ? -
The set of data types which can be collected on this device.
read / write, inherited
- type → String
-
The device type identifier
@JsonKey(ignore: true), read-only, inherited
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. [...]
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
Constants
- DEFAULT_ROLENAME → const String
-
The default rolename for a custom protocol device.
'Custom device'