runtime library

Contains classes for running the sensing framework incl. the StudyDeploymentExecutor, TaskExecutor and different types of abstract Probes.

Classes

AbstractDataManager
An abstract DataManager implementation useful for extension. [...]
AbstractProbe
An abstract implementation of a Probe to extend from.
AppTaskController
A controller of UserTasks which accessible in the userTaskQueue.
AppTaskExecutor
Executes an AppTask. [...]
AutomaticTaskExecutor
Executes an AutomaticTask.
BTLEDeviceManager
BufferingPeriodicProbe
An abstract probe which can be used to sample data into a buffer, every frequency for a period of duration. These events are buffered, and once collected for the duration, are collected from the getDatum method and send to the main data stream. [...]
BufferingPeriodicStreamProbe
An abstract probe which can be used to sample data from a buffering stream, every frequency for a period of duration. These events are buffered, and once collected for the duration, are collected from the getDataPoint method and send to the main data stream. [...]
BufferingStreamProbe
An abstract probe which can be used to buffer data from a stream and collect data every frequency. All events from the bufferingStream are buffered, and collected from the getDatum method every frequency and send to the main data stream. [...]
ConditionalSamplingEventTriggerExecutor
Executes a ConditionalSamplingEventTrigger based on the specified ConditionalSamplingEventTrigger.measureType and their ConditionalSamplingEventTrigger.resumeCondition and ConditionalSamplingEventTrigger.pauseCondition.
CronScheduledTriggerExecutor
Executes a CronScheduledTrigger based on the specified cron job.
DataManagerRegistry
A registry of DataManagers. [...]
DateTimeTriggerExecutor
Executes a DateTimeTrigger on the specified DateTimeTrigger.schedule date and time.
DatumProbe
This probe collects one piece of Datum when resumed, send its to the data stream, and then pause. [...]
DebugLevel
DelayedTriggerExecutor
Executes a DelayedTrigger, i.e. resumes sampling after the specified delay. Once started, it can be paused / resumed as any other Executor.
DeviceController
A DeviceController handles runtime managenent of all devices connected to this phone, including the phone itsel.
DeviceManager
A DeviceManager handles a device on runtime.
Executor
An abstract class used to implement executors. See StudyDeploymentExecutor and TaskExecutor for examples.
ImmediateTriggerExecutor
Executes a ImmediateTrigger, i.e. starts sampling immediately.
LightSamplingState
MinimumSamplingState
NormalSamplingState
NoSamplingState
OneTimeSensingUserTask
A non-UI sensing taks that collects sensor data once. For example collecting a location datum. [...]
PassiveTriggerExecutor
Executes a PassiveTrigger.
PeriodicDatumProbe
A periodic probe is triggered at regular intervals, specified by its frequency property in a PeriodicMeasure. [...]
PeriodicStreamProbe
A periodic probe listening on a stream. Listening is done periodically as specified in a PeriodicMeasure listening on intervals every frequency for a period of duration. During this period, all data are forwarded to this probes data stream. [...]
PeriodicTriggerExecutor
Executes a PeriodicTrigger, i.e. resumes sampling on a regular basis for a given period of time. [...]
PowerAwarenessState
This default power-awareness schema operates with four power states: [...]
Probe
A Probe is responsible for collecting data. [...]
ProbeRegistry
The ProbeRegistry can create, register, and lookup an instance of a relevant probe based on its CAMSDataType.
RandomRecurrentTriggerExecutor
Executes a RandomRecurrentTrigger triggering N times per day within a defined period of time.
RecurrentScheduledTriggerExecutor
Executes a RecurrentScheduledTrigger.
SamplingEventTriggerExecutor
Executes a SamplingEventTrigger based on the specified SamplingEventTrigger.measureType and SamplingEventTrigger.resumeCondition.
SamplingPackage
Interface for a sampling package. [...]
SamplingPackageRegistry
A registry of SamplingPackage packages.
SensingUserTask
A non-UI sensing taks that collects sensor data. For example, a noise datum. [...]
SensingUserTaskFactory
A UserTaskFactory that can create non-UI sensing tasks: [...]
Settings
Misc. settings for CAMS. [...]
SmartPhoneClientManager
SmartphoneDeploymentService
A local (in-memory) implementation of a DeploymentService useful in CAMS studies to be deployed locally on this phone.
SmartphoneDeviceManager
A device manager for this smartphone.
SmartphoneSamplingPackage
An abstract class for all sampling packages that run on the phone itself.
StreamProbe
An abstract class used to create a probe that listen to events from a stream of Datum objects. [...]
StudyDeploymentController
A StudyDeploymentController controls the execution of a CAMSMasterDeviceDeployment.
StudyDeploymentExecutor
The StudyDeploymentExecutor is responsible for executing a MasterDeviceDeployment. For each triggered task in this deployment, it starts a TriggeredTaskExecutor. [...]
StudyProtocolManager
An interface defining a manger of a StudyProtocol. [...]
TaskExecutor
The TaskExecutor is responsible for executing a TaskDescriptor in the StudyProtocol. For each task it looks up appropriate Probes to collect data. [...]
TriggeredTaskExecutor
Responsible for handling the execution of a TriggeredTask. [...]
TriggerExecutor
Responsible for handling the execution of a Trigger. [...]
UserTask
A task that the user of the app needs to attend to. [...]
UserTaskFactory
A factory which can create a UserTask based on the type of an AppTask.

Functions

debug(String message) → void
A simple method for printing debug messages to the console.
getTaskExecutor(TaskDescriptor task) TaskExecutor
Returns the relevant TaskExecutor based on the type of task.
getTriggerExecutor(Trigger trigger) TriggerExecutor
Returns the relevant TriggerExecutor based on the type of trigger.
info(String message) → void
A simple method for printing warning messages to the console.
warning(String message) → void
A simple method for printing warning messages to the console.

Enums

DeviceStatus
Different status for a device.
ProbeState
The state of a Probe. [...]
UserTaskState
The states of a UserTask.

Exceptions / Errors

SensingException
Generic sensing exception.