domain library Null safety

The CAMS implementation of the core CARP domain classes like StudyProtocol, TaskDescriptor, and Measure. Also hold JSON serialization and deseralization logic to handle seraialization of the domain objects.

Classes

AppTask
A task that notifies the app when it is triggered. [...]
AutomaticTask
A task that automatically collects data from the specified measures. Runs without any interaction with the user or UI of the app.
CAMSDataType
Enumeration of data types used in DataType and DataFormat.
CAMSMeasure
A CAMS-specific Measure that holds information about what measure to collect in a task.
CARPTransformerSchema
A default DatumTransformerSchema for CARP no-operation transformers
ConditionalEvent
Specified the configuration of an event in a SamplingEventTrigger. [...]
ConditionalSamplingEventTrigger
A trigger that resume and pause sampling when some (other) sampling event occurs and a application-specific condition is meet. [...]
ConnectableDeviceDescriptor
Describes any type of device which can be "connected" to this phone. [...]
CronScheduledTrigger
A trigger that resume and pause sampling based on a cron job specification. [...]
DateTimeTrigger
A trigger that starts sampling based on a schedule of a date and time, and runs for a specific duration.
Datum
A base (abstract) class for a single unit of sensed information.
DatumTransformerSchema
An abstract class defining a transformer schema, which hold a set of DatumTransformers, which that can map from the native CARP namespace to another namespace. A DatumTransformerSchema must be implemented for each supported namespace.
DelayedTrigger
A trigger that delays sampling for delay and then starts sampling. Never stops sampling once started. [...]
DeploymentDelayedTrigger
A trigger that delays sampling for delay and then starts sampling. Never stops sampling once started. [...]
DeviceInfo
Provides (static) information about the local device. [...]
DomainJsonFactory
ErrorDatum
A Datum object holding a Error, i.e. that the probe / sensor returned some sort of error, which is reported back.
FileDataEndPoint
Specify an endpoint where a file-based DataManager can store JSON data as files on the local device.
FileDatum
A Datum object holding a link to a file.
ImmediateTrigger
A trigger that starts sampling immediately and never stops.
MapDatum
A generic Datum that holds a map of key, value string objects.
MarkedMeasure
A MarkedMeasure specify how to collect data historically back to a persistent mark. [...]
MeasureListener
A Listener that can listen on changes to a Measure.
MultiDatum
A Datum object holding multiple Datums of the same type.
OMHTransformerSchema
A default DatumTransformerSchema for Open mHealth (OMH) transformers
PassiveTrigger
A trigger that waits to be started until the resume method is called. Is paused by calling the pause method. [...]
PeriodicMeasure
A PeriodicMeasure specify how to collect data on a regular basis. [...]
PeriodicTrigger
A trigger that resume/pause sampling every period for a specific duration. [...]
PrivacySchema
A default DatumTransformerSchema for privacy transformers
RandomRecurrentTrigger
A trigger that triggers a random number of times within a defined period of time in a day. [...]
RecurrentScheduledTrigger
A trigger that resume/pause sampling based on a recurrent scheduled date and time. Stops / pause after the specified duration. [...]
SamplingEventTrigger
A trigger that resume and pause sampling when some (other) sampling event occurs. [...]
SamplingSchema
Specify how sampling should be done. Used to make default configuration of Measures. [...]
SmartphoneDeployment
Contains the entire description and configuration for how a smartphone master device participates in deployment of a study.
SmartphoneStudyProtocol
A description of how a study is to be executed on a smartphone. [...]
StringDatum
A simple Datum that only holds a string datum object.
StudyDescription
StudyResponsible
A person who is responsible for a StudyProtocol. Typically the Principal Investigator (PI) who is reposnibile for the study.
Time
A time on a day. [...]
TransformedDatum
An interface for Datum that is created from a transformer.
TransformerSchemaRegistry
A registry of DatumTransformerSchemas which hold a set of DatumTransformers.

Properties

tmp DomainJsonFactory
read / write

Functions

noop(Datum datum) Datum
A no-operation transformer.

Enums

RecurrentType
Type of recurrence for a RecurrentScheduledTrigger.
SamplingSchemaType
A enumeration of known sampling schemas types.

Typedefs

ConditionalEventEvaluator = bool Function(DataPoint dataPoint)
Takes a DataPoint from a sampling stream and evaluates if an event has occurred. Returns true if the event has occurred, false otherwise.
DatumTransformer = Datum Function(Datum)
Signature of a data transformer.