DataTypeSamplingScheme

Specifies the sampling scheme for a data type (dataType), including possible options, defaults, and constraints.

From sampling schemes, matching sampling configurations can be created. Per data type, only one SamplingConfiguration is ever active on a device. The sampling configuration to be used is determined on clients in the following order of priority:

• The sampling configuration, if specified in the study protocol, as part of the Measure as part of the Measure.overrideSamplingConfiguration.

• The default sampling configuration, if specified in the study protocol, as part of the DeviceConfiguration.defaultSamplingConfiguration. This can be retrieved through the PrimaryDeviceDeployment on the client.

• The default sampling configuration hardcoded in the DeviceConfiguration.dataTypeSamplingSchemes sampling schemes of the concrete DeviceConfiguration, if none of the previous configurations are present.

See also the section on Sampling schemes and configurations in the CARP Core Framework.

Constructors

DataTypeSamplingScheme

DataTypeSamplingScheme(

1. DataTypeMetaData dataType, [
2. SamplingConfiguration? defaultSamplingConfiguration

])

Create a scheme for dataType. The default configuration is a NoOptionsSamplingConfiguration if defaultSamplingConfiguration is not specified.

Properties

dataType

DataTypeMetaData dataType

getter/setter pair

The data type this sampling scheme relates to.

defaultSamplingConfiguration

SamplingConfiguration defaultSamplingConfiguration

getter/setter pair

The default configuration to use when no other configuration is specified.

measure

Measure get measure

Create a Measure for the dataType defined by this sampling scheme, and override the measure's default SamplingConfiguration with this scheme's defaultSamplingConfiguration.

type

String get type

The data type as String.