CharacteristicBodyCompositionMeasurement

@available(swift 3.1)
@available(iOS 10.0, tvOS 10.0, watchOS 3.0, macOS 10.12, *)
final public class CharacteristicBodyCompositionMeasurement : Characteristic
extension CharacteristicBodyCompositionMeasurement: Hashable
extension CharacteristicBodyCompositionMeasurement: Equatable

BLE Body Composition Measurement Characteristic

  • Characteristic Name

    Declaration

    Swift

    public static var name: String { get }

  • Characteristic UUID

    Declaration

    Swift

    public static var uuidString: String { get }

  • Name of the Characteristic

    Declaration

    Swift

    public var name: String { get }

  • Characteristic UUID String

    Declaration

    Swift

    public var uuidString: String { get }

  • Body Fat Percentage

    Declaration

    Swift

    private(set) public var bodyFat: Measurement<UnitPercent> { get }

  • Timestamp

    Declaration

    Swift

    private(set) public var currentTime: DateTime? { get }

  • User ID

    Declaration

    Swift

    private(set) public var userID: User? { get }

  • Basal Metabolism

    Declaration

    Swift

    private(set) public var basalMetabolism: Measurement<UnitEnergy>? { get }

  • Muscle Percentage

    Declaration

    Swift

    private(set) public var musclePercentage: Measurement<UnitPercent>? { get }

  • Muscle Mass

    Declaration

    Swift

    private(set) public var muscleMass: Measurement<UnitMass>? { get }

  • Fat Free Mass

    Declaration

    Swift

    private(set) public var fatFreeMass: Measurement<UnitMass>? { get }

  • Soft Lean Mass

    Declaration

    Swift

    private(set) public var softLeanMass: Measurement<UnitMass>? { get }

  • Body Water Mass

    Declaration

    Swift

    private(set) public var bodyWaterMass: Measurement<UnitMass>? { get }

  • Impedance

    Declaration

    Swift

    private(set) public var impedance: Measurement<UnitElectricResistance>? { get }

  • Weight

    Declaration

    Swift

    private(set) public var weight: Measurement<UnitMass>? { get }

  • Height

    Declaration

    Swift

    private(set) public var height: Measurement<UnitLength>? { get }

  • Multiple Packet Measurement

    Declaration

    Swift

    private(set) public var multiplePacketMeasurement: Bool { get }

  • Creates Body Composition Measurement Characteristic

    Declaration

    Swift

    public init(bodyFat: Measurement<UnitPercent>,
            currentTime: DateTime?,
            userID: User?,
            basalMetabolism: Measurement<UnitEnergy>?,
            musclePercentage: Measurement<UnitPercent>?,
            muscleMass: Measurement<UnitMass>?,
            fatFreeMass: Measurement<UnitMass>?,
            softLeanMass: Measurement<UnitMass>?,
            bodyWaterMass: Measurement<UnitMass>?,
            impedance: Measurement<UnitElectricResistance>?,
            weight: Measurement<UnitMass>?,
            height: Measurement<UnitLength>?,
            multiplePacketMeasurement: Bool)

    Parameters

    bodyFat

    Body Fat Percentage
    currentTime

    Timestamp
    userID

    User ID
    basalMetabolism

    Basal Metabolism
    musclePercentage

    Muscle Percentage
    muscleMass

    Muscle Mass
    fatFreeMass

    Fat Free Mass
    softLeanMass

    Soft Lean Mass
    bodyWaterMass

    Body Water Mass
    impedance

    Impedance
    weight

    Weight
    height

    Height
    multiplePacketMeasurement

    Multiple Packet Measurement

  • Decodes Characteristic Data into Characteristic

    Declaration

    Swift

    public class func decode<C>(with data: Data) -> Result<C, BluetoothDecodeError> where C : Characteristic

    Parameters

    data

    Characteristic Data

    Return Value

    Characteristic Result

  • Encodes the Characteristic into Data

    Declaration

    Swift

    public func encode() -> Result<Data, BluetoothEncodeError>

    Return Value

    Characteristic Data Result

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    Never call finalize() on hasher. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    public func hash(into hasher: inout Hasher)

    Parameters

    hasher

    The hasher to use when combining the components of this instance.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

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

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.