CustomProtocolDevice class

A general-purpose master device for custom protocols. Only used when downloading custom protocols from the CARP web service.

Inheritance

• Object
• Serializable
• DeviceDescriptor
• MasterDeviceDescriptor
• CustomProtocolDevice

Annotations

• @JsonSerializable.new(fieldRename: FieldRename.none, includeIfNull: false)

Constructors

CustomProtocolDevice({String roleName = CustomProtocolDevice.DEFAULT_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.

getter/setter pair, inherited

fromJsonFunction → Function

The function which can convert a JSON string to an object of this type.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

isMasterDevice ↔ bool?

Is this the master device?

getter/setter pair, 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.

no setter, inherited

roleName ↔ String

The role name of this device in a specific StudyProtocol. For example, 'Parent's phone' or 'Child phone'.

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

samplingConfiguration ↔ Map<String, SamplingConfiguration>

Sampling configurations for data types available on this device which override the default configuration.

getter/setter pair, inherited

supportedDataTypes ↔ List<String>?

The set of data types which can be collected on this device.

getter/setter pair, inherited

type → String

The device type identifier

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent 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.