Skip to content

CustomProtocolTask

A task which contains a definition of a custom protocol which differs from the CARP domain model.

Created by ProtocolFactoryService.createCustomProtocol and run on a CustomProtocolDevice. Has no measures.

Inheritance
Annotations

Constructors

CustomProtocolTask.fromJson

CustomProtocolTask.fromJson(
  1. Map<String, dynamic> json
)

CustomProtocolTask

CustomProtocolTask({
  1. String? name,
  2. String? description,
  3. required String studyProtocol,
})

Create a task which is used in a custom protocol, specified as a string in studyProtocol.

Properties

fromJsonFunction

Function get fromJsonFunction
override

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

studyProtocol

String studyProtocol
getter/setter pair

A definition on how to run a study on a primary device, serialized as a string.

Methods

toJson

Map<String, dynamic> toJson()
override

Return a JSON encoding of this object.

toString

String toString()
override

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.