MobilityStep<TResult extends MobilityResult, TMeasure extends MobilityMeasure> class abstract

Abstract base class for mobility steps in the CARP Mobility Package.

TResult is the type of result produced by the step. TMeasure is the type of measure used by the step.

Inheritance
  • Object
  • Serializable
  • RPStep
  • RPActivityStep
  • MobilityStep
Implementers

Constructors

MobilityStep.new({required String identifier, required TMeasure measure, required MobilityConfig config, required MobilityProbe probe, bool includeInstructions = false, bool includeResults = false})
Constructs a MobilityStep with the required parameters.

Properties

$type ↔ String?
The runtime class name (type) of this object. Used for deserialization from JSON objects.
getter/setter pairinherited
config → MobilityConfig
The configuration for this mobility step.
final
footnote ↔ String?
Optional footer text to be displayed below the question. This can be used to provide additional information, such as copyright, or instructions. This text will be displayed in a smaller font size.
getter/setter pairinherited
fromJsonFunction → Function
The function which can convert a JSON string to an object of this type.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
identifier → String
A unique identifier of the Step. This identifier connects the step to its result (RPResult) object.
finalinherited
includeInstructions ↔ bool
Show the instruction before the test?
getter/setter pairinherited
includeResults ↔ bool
Show the results after the test?
getter/setter pairinherited
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 setterinherited
measure → TMeasure
The measure associated with this mobility step.
final
optional ↔ bool
Can this step be skipped? If so, the result for the step will be null.
getter/setter pairinherited
probe → MobilityProbe
The probe used to collect mobility data.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stepWidget → Widget
The widget (UI representation) of the step.
no setterinherited
text ↔ String?
The text of the Step. Different types of Steps are using the text text differently.
getter/setter pairinherited
timer ↔ Timer?
getter/setter pairinherited
title ↔ String
The title text. Different types of Steps are using the title text differently.
getter/setter pairinherited

Methods

calculateScore(dynamic result) → int
Calculates the score for this activity step.
inherited
execute() → Future<TResult>
Executes the mobility step and returns a TResult asynchronously.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
stepBody(dynamic onResultChange(dynamic), RPActivityEventLogger eventLogger) → Widget
Returns the widget that displays the body of the step.
override
toJson() → Map<String, dynamic>
Return a JSON encoding of this object.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited