TimelineItem

open class TimelineItem: TimelineObject, Hashable, Comparable, Codable

The abstract base class for timeline items.

TimelineObject

  • Undocumented

    Declaration

    Swift

    public var objectId: UUID

  • Undocumented

    Declaration

    Swift

    public weak var store: TimelineStore?

  • Undocumented

    Declaration

    Swift

    internal(set) public var inTheStore = false

  • Undocumented

    Declaration

    Swift

    open var currentInstance: TimelineItem?

  • Undocumented

    Declaration

    Swift

    public var classifier: TimelineClassifier?

  • Undocumented

    Declaration

    Swift

    public var mutex = PThreadMutex(type: .recursive)

  • Undocumented

    Declaration

    Swift

    public let itemId: UUID

  • Undocumented

    Declaration

    Swift

    private(set) public var lastModified: Date

  • Undocumented

    Declaration

    Swift

    open var isMergeLocked: Bool

  • Undocumented

    Declaration

    Swift

    public var deleted = false

  • Undocumented

    Declaration

    Swift

    open var stepCount: Int?

  • Undocumented

    Declaration

    Swift

    public var floorsAscended: Int?

  • Undocumented

    Declaration

    Swift

    public var floorsDescended: Int?

  • Undocumented

    Declaration

    Swift

    open var samples: [LocomotionSample]

  • Undocumented

    Declaration

    Swift

    private(set) public var _dateRange: DateInterval?

  • Undocumented

    Declaration

    Swift

    public var dateRange: DateInterval?

  • Undocumented

    Declaration

    Swift

    public var startDate: Date?

  • Undocumented

    Declaration

    Swift

    public var endDate: Date?

  • Undocumented

    Declaration

    Swift

    public var duration: TimeInterval

  • Undocumented

    Declaration

    Swift

    public var previousItemId: UUID?

  • Undocumented

    Declaration

    Swift

    public var nextItemId: UUID?

  • Undocumented

    Declaration

    Swift

    public var previousItem: TimelineItem?

  • Undocumented

    Declaration

    Swift

    public var nextItem: TimelineItem?

  • Undocumented

    Declaration

    Swift

    public var isCurrentItem: Bool

Timeline item validity

  • Undocumented

    Declaration

    Swift

    public var isInvalid: Bool

  • Undocumented

    Declaration

    Swift

    open var isValid: Bool

  • Undocumented

    Declaration

    Swift

    open var isWorthKeeping: Bool

  • Undocumented

    Declaration

    Swift

    public var keepnessScore: Int

  • Undocumented

    Declaration

    Swift

    public var isDataGap: Bool

  • Undocumented

    Declaration

    Swift

    public var isNolo: Bool

  • Undocumented

    Declaration

    Swift

    public var radius0sd: Double

  • Undocumented

    Declaration

    Swift

    public var radius1sd: Double

  • Undocumented

    Declaration

    Swift

    public var radius2sd: Double

  • Undocumented

    Declaration

    Swift

    public var radius3sd: Double

  • Undocumented

    Declaration

    Swift

    public var segments: [ItemSegment]

Activity Types

  • The ActivityTypeClassifier results for the timeline item.

    Declaration

    Swift

    public var classifierResults: ClassifierResults?

  • The unfiltered ActivityTypeClassifier results for the timeline item.

    Declaration

    Swift

    public var unfilteredClassifierResults: ClassifierResults?

  • Undocumented

    Declaration

    Swift

    private(set) public var _activityType: ActivityTypeName?

  • The highest scoring activity type for the timeline’s samples.

    Declaration

    Swift

    public var activityType: ActivityTypeName?

  • Undocumented

    Declaration

    Swift

    public var movingActivityType: ActivityTypeName?

  • The most common activity type for the timeline item’s samples.

    Declaration

    Swift

    public var modeActivityType: ActivityTypeName?

  • The most common moving activity type for the timeline item’s samples.

    Declaration

    Swift

    public var modeMovingActivityType: ActivityTypeName?

Comparisons and Helpers

  • The time interval between this item and the given item.

    Note

    A negative value indicates overlapping items, and thus the duration of their overlap.

    Declaration

    Swift

    public func timeInterval(from otherItem: TimelineItem) -> TimeInterval?

  • Undocumented

    Declaration

    Swift

    open func withinMergeableDistance(from otherItem: TimelineItem) -> Bool

  • Undocumented

    Declaration

    Swift

    public func contains(_ location: CLLocation, sd: Double) -> Bool

  • Undocumented

    Declaration

    Swift

    public func distance(from: TimelineItem) -> CLLocationDistance?

  • Undocumented

    Declaration

    Swift

    public func maximumMergeableDistance(from: TimelineItem) -> CLLocationDistance

  • Undocumented

    Declaration

    Swift

    public func sanitiseEdges()

  • Undocumented

    Declaration

    Swift

    public func cleanseEdge(with path: Path) -> LocomotionSample?

  • Undocumented

    Declaration

    Swift

    open func scoreForConsuming(item: TimelineItem) -> ConsumptionScore

  • For subclasses to perform additional actions when merging items, for example copying and preserving subclass properties.

    Declaration

    Swift

    open func willConsume(item: TimelineItem)

Modifying the timeline item

  • Undocumented

    Declaration

    Swift

    open func edit(changes: (TimelineItem) -> Void)

  • Undocumented

    Declaration

    Swift

    public func add(_ sample: LocomotionSample)

  • Undocumented

    Declaration

    Swift

    public func remove(_ sample: LocomotionSample)

  • Undocumented

    Declaration

    Swift

    open func add(_ samples: [LocomotionSample])

  • Undocumented

    Declaration

    Swift

    open func remove(_ samples: [LocomotionSample])

  • Undocumented

    Declaration

    Swift

    open func samplesChanged()

  • Undocumented

    Declaration

    Swift

    private(set) public var _center: CLLocation?

  • Undocumented

    Declaration

    Swift

    public var center: CLLocation?

  • Undocumented

    Declaration

    Swift

    private(set) public var _radius: Radius?

  • Undocumented

    Declaration

    Swift

    public var radius: Radius

  • Undocumented

    Declaration

    Swift

    private(set) public var _altitude: CLLocationDistance?

  • Undocumented

    Declaration

    Swift

    public var altitude: CLLocationDistance?

  • Undocumented

    Declaration

    Swift

    public func updatePedometerData()

Hashable, Comparable

  • Declaration

    Swift

    public var hashValue: Int

  • Declaration

    Swift

    public static func ==(lhs: TimelineItem, rhs: TimelineItem) -> Bool

  • Declaration

    Swift

    public static func <(lhs: TimelineItem, rhs: TimelineItem) -> Bool

Required initialisers

Codable

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    open func encode(to encoder: Encoder) throws