Contents

predicateForWorkouts(with:totalSwimmingStrokeCount:)

Returns a predicate that matches workout samples based on the number of strokes while swimming.

Declaration

class func predicateForWorkouts(with operatorType: NSComparisonPredicate.Operator, totalSwimmingStrokeCount: HKQuantity) -> NSPredicate

Parameters

  • operatorType:

    The operator to use when comparing the sample to the target number of flights climbed.

  • totalSwimmingStrokeCount:

    A quantity representing the target stroke count.

Return Value

A predicate that matches workouts based on the number of strokes while swimming.

Discussion

This convenience method creates a predicate that compares the number of swimming strokes during a workout with a target number. The following sample uses the convenience method and a predicate format string to create equivalent predicates.

// Creating a predicate using the convenience method.
let swimmingStrokeCount = HKQuantity(unit: HKUnit.count(), doubleValue: 500.0)
let longSwim = HKQuery.predicateForWorkouts(with: .greaterThanOrEqualTo, totalSwimmingStrokeCount: swimmingStrokeCount)

// Creating a predicate using a predicate format string.
let explicitLongSwim = NSPredicate(format: "%K >= %@",
                                   HKPredicateKeyPathWorkoutTotalSwimmingStrokeCount,
                                   swimmingStrokeCount)

See Also

Related Documentation

Creating workout predicates