DeviceDeploymentStatus

The status of one device in a study deployment.

Part of StudyDeploymentStatus.deviceStatusList. Tells whether the device is registered or deployed, and which other devices must be registered first.

See DeviceDeploymentStatus.kt.

Inheritance

• Object
• Serializable
• DeviceDeploymentStatus

Annotations

• @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

DeviceDeploymentStatus.fromJson

DeviceDeploymentStatus.fromJson(

1. Map<String, dynamic> json

)

DeviceDeploymentStatus

DeviceDeploymentStatus({

1. required DeviceConfiguration<DeviceRegistration> device,

})

Properties

canBeDeployed

bool? canBeDeployed

getter/setter pair

Determines whether the device can be deployed by retrieving a PrimaryDeviceDeployment.

Only primary devices can be deployed. However, not all primary devices necessarily need deployment; chained primary devices do not.

Is null if already deployed, i.e., status is DeviceDeploymentStatusTypes.Deployed.

canObtainDeviceDeployment

bool get canObtainDeviceDeployment

Determines whether the device requires a device deployment, and if so, whether the deployment configuration (to initialize the device environment) can be obtained. This requires the specified device and all other primary devices it depends on to be registered.

device

DeviceConfiguration<DeviceRegistration> device

getter/setter pair

The description of the device.

fromJsonFunction

1. @override

Function get fromJsonFunction

override

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

isReadyForDeployment

bool get isReadyForDeployment

Determines whether the device and all dependent devices have been registered successfully and is ready for deployment.

jsonType

1. @override

String get jsonType

override

Return the __type to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.

remainingDevicesToRegisterBeforeDeployment

List<String>? remainingDevicesToRegisterBeforeDeployment

getter/setter pair

The role names of devices which need to be registered before this device can be declared as successfully deployed.

remainingDevicesToRegisterToObtainDeployment

List<String>? remainingDevicesToRegisterToObtainDeployment

getter/setter pair

The role names of devices which need to be registered before the deployment information for this device can be obtained.

status

1. @JsonKey(includeFromJson: false, includeToJson: false)

DeviceDeploymentStatusTypes status

getter/setter pair

Get the status of this device deployment:

• Unregistered
• Registered
• Deployed
• NeedsRedeployment

Methods

toJson

1. @override

Map<String, dynamic> toJson()

override

Return a JSON encoding of this object.

toString

1. @override

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.