Class Datum

A single unit of sensed information returned by a probe.

Inheritance

System.Object

Datum

SensingAgentStateDatum

HeartbeatDatum

ImpreciseDatum

ParticipationReportDatum

ParticipationRewardDatum

SmsDatum

TelephonyDatum

AmbientTemperatureDatum

BluetoothDeviceProximityDatum

HumidityDatum

LightDatum

SoundDatum

BatteryDatum

ScreenDatum

AltitudeDatum

CompassDatum

EstimoteBeaconDatum

EstimoteIndoorLocationDatum

PointOfInterestProximityDatum

ProximityDatum

AccelerometerDatum

ActivityDatum

GyroscopeDatum

CellTowerDatum

WlanDatum

BiologicalSexDatum

BirthdateDatum

BloodTypeDatum

BodyMassIndexDatum

DistanceWalkingRunningDatum

FitzpatrickSkinTypeDatum

FlightsClimbedDatum

HeartRateDatum

HeightDatum

NumberOfTimesFallenDatum

StepCountDatum

WeightDatum

WheelChairUseDatum

ScriptDatum

ScriptStateDatum

ProtocolSettingUpdateDatum

Implements

IDatum

Namespace: Sensus

Assembly: SensusAndroid.dll

Syntax

public abstract class Datum : Object, IDatum

Constructors

Datum()

Parameterless constructor For JSON.NET deserialization.

Declaration

protected Datum()

Datum(DateTimeOffset)

Declaration

protected Datum(DateTimeOffset timestamp)

Parameters

Type	Name	Description
System.DateTimeOffset	timestamp

Properties

Anonymized

Whether or not this Datum has been run through an anonymizer.

Declaration

public bool Anonymized { get; set; }

Property Value

Type	Description
System.Boolean	true if anonymized; otherwise, false.

BuildId

The identifier for the build of Sensus that generated this datum.

Declaration

public string BuildId { get; set; }

Property Value

Type	Description
System.String	The build identifier.

DeviceId

An identifier that is unique to the particular device running Sensus. The meaning of this identifier and conditions under which it can change are described in the following pages:

• Android: See here.
• iOS: See here.

Declaration

[Anonymizable]
public string DeviceId { get; set; }

Property Value

Type	Description
System.String	The device identifier.

DeviceManufacturer

The device manufacturer.

Declaration

public string DeviceManufacturer { get; set; }

Property Value

Type	Description
System.String	The device manufacturer.

DeviceModel

The device model.

Declaration

public string DeviceModel { get; set; }

Property Value

Type	Description
System.String	The device model.

DisplayDetail

Declaration

public abstract string DisplayDetail { get; }

Property Value

Type	Description
System.String

Id

Unique identifier for the current Datum, unique across all data generated by all Sensus apps.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String	The identifier.

LocalOffsetFromUTC

The local time zone's offset from UTC.

Declaration

public TimeSpan LocalOffsetFromUTC { get; set; }

Property Value

Type	Description
System.TimeSpan	The local offset from UTC.

OperatingSystem

The operating system.

Declaration

public string OperatingSystem { get; set; }

Property Value

Type	Description
System.String	The operating system.

ParticipantId

The identifier for the participant that generated this datum. This will be null if StartConfirmationMode is set to None or RandomDigits. If StartConfirmationMode is set to ParticipantIdDigits or ParticipantIdText then this will be the value entered by the user. If StartConfirmationMode is set to ParticipantIdQrCode then this will be the value of the scanned QR code.

Declaration

public string ParticipantId { get; set; }

Property Value

Type	Description
System.String	The participant identifier.

ProtocolId

A unique identifier for the Protocol that generated this Datum.

Declaration

public string ProtocolId { get; set; }

Property Value

Type	Description
System.String	The protocol identifier.

SensingAgentStateDescription

If the Protocol is configured with a SensingAgent, then this will contain the value of StateDescription for convenience in evaluating the effects of a SensingAgent. Note that the SensingAgent will also submit SensingAgentStateDatum objects to record the SensingAgentState trajectory of the SensingAgent over time.

Declaration

public string SensingAgentStateDescription { get; set; }

Property Value

Type	Description
System.String	The sensing agent state description.

StringPlaceholderValue

Gets the string placeholder value, which is used as a formatting replacement in strings such as Caption and LabelText.

Declaration

public abstract object StringPlaceholderValue { get; }

Property Value

Type	Description
System.Object	The string placeholder value.

TaggedEventId

The event identifier, as described here.

Declaration

public string TaggedEventId { get; set; }

Property Value

Type	Description
System.String	The tagged event identifier.

TaggedEventTags

The event tags, as described here.

Declaration

public List<string> TaggedEventTags { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	The tagged event identifier.

Timestamp

Date and time at which a data element from the Probe was read.

Declaration

[Anonymizable]
public DateTimeOffset Timestamp { get; set; }

Property Value

Type	Description
System.DateTimeOffset	The timestamp.

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

FromJSON(String)

Declaration

public static Datum FromJSON(string json)

Parameters

Type	Name	Description
System.String	json

Returns

Type	Description
Datum

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

GetJSON(AnonymizedJsonContractResolver, Boolean)

Declaration

public string GetJSON(AnonymizedJsonContractResolver anonymizationContractResolver, bool indented)

Parameters

Type	Name	Description
AnonymizedJsonContractResolver	anonymizationContractResolver
System.Boolean	indented

Returns

Type	Description
System.String

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Implements

IDatum