CalendarMeasure class
- Inheritance
-
- Object
- Serializable
- Measure
- CAMSMeasure
- CalendarMeasure
- Annotations
-
- @JsonSerializable(fieldRename: FieldRename.none, includeIfNull: false)
Constructors
- CalendarMeasure.new({required String type, String? name, String? description, dynamic enabled = true, Duration? past, Duration? future})
-
CalendarMeasure.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 pairinherited
-
configuration
↔ Map<
String, String> -
A key-value map holding any application-specific configuration.
getter/setter pairinherited
- dataType → DataType
-
The type of measure to do as a
DataType
.no setterinherited - description ↔ String?
-
A longer description of this measure.
getter/setter pairinherited
- enabled ↔ bool
-
Whether the measure is enabled - i.e. collecting data - when the
study is running. A measure is enabled as default.
getter/setter pairinherited
- fromJsonFunction → Function
-
The function which can convert a JSON string to an object of this type.
no setteroverride
- future ↔ Duration
-
The time duration ahead in time to collect calendar events.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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
- name ↔ String?
-
A printer-friendly name for this measure.
getter/setter pairinherited
- past ↔ Duration
-
The time duration back in time to collect calendar events.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- studyDeploymentId ↔ String?
-
The study deployment id that this measure is part of.
Set on runtime.
getter/setter pairinherited
- type ↔ String
-
The type of measure to do.
getter/setter pairinherited
Methods
-
adapt(
Measure measure) → void -
Adapt this measure to a new value specified in
measure
.inherited -
addMeasureListener(
MeasureListener listener) → void -
Add a
MeasureListener
to thisMeasure
.inherited -
getConfiguration(
String key) → String? -
Get value from the configuration for this measure.
inherited
-
hasChanged(
) → Future -
Call this method when this measure has changed.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeMeasureListener(
MeasureListener listener) → void -
Remove a
MeasureListener
to thisMeasure
.inherited -
restore(
) → void -
Restore this measure to its original value before
adapt
was called.inherited -
setConfiguration(
String key, String configuration) → void -
Add a key-value pair as configuration for this measure.
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_NUMBER_OF_DAYS → const int