DataEndPoint class
Says where and how the measurements of a study are stored or uploaded.
Set it as SmartphoneStudyProtocol.dataEndPoint. At runtime, the
DataManagerRegistry creates the DataManager whose
DataManagerFactory.type matches type, and that data manager stores or
uploads each Measurement.
Key points:
- type selects the data manager, see DataEndPointTypes.
- dataFormat selects the DataTransformerSchema used to transform data
before it is stored, e.g.
NameSpace.OMH. - Subclass it to add settings for your own data manager, e.g. FileDataEndPoint or SQLiteDataEndPoint.
- Inheritance
-
- Object
- Serializable
- DataEndPoint
- Implementers
- Annotations
-
- @JsonSerializable.new(includeIfNull: false, explicitToJson: true)
Constructors
- DataEndPoint({required String type, String dataFormat = NameSpace.CARP})
-
Creates a DataEndPoint of
type(see DataEndPointTypes). -
DataEndPoint.fromJson(Map<
String, dynamic> json) -
factory
Properties
- $type ↔ String?
-
The type name written to
__typein JSON; set tojsonTypeon creation.getter/setter pairinherited - dataFormat ↔ String
-
The preferred format of the data to be uploaded according to
NameSpace. Default using theNameSpace.CARP.getter/setter pair - fromJsonFunction → Function
-
The generated function that converts a JSON map to an object of this type.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- jsonType → String
-
The
__typeused for JSON serialization of this class.no setterinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type ↔ String
-
The type of endpoint as enumerated in DataEndPointTypes.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON map of this object, including the
__typeproperty.override -
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited