Wahoo Fitness API  3.6.1
Documentation for the iPhone version of the Wahoo Fitness API.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
WFANTWeightScaleData Class Reference

Represents the data available from the ANT+ Weight Scale sensor. More...

#import <WFANTWeightScaleData.h>

+ Inheritance diagram for WFANTWeightScaleData:
+ Collaboration diagram for WFANTWeightScaleData:

Instance Methods

(NSString *) - formattedWeight:
 

Properties

float activeMetabolicRate
 Advanced data - Active metabolic Rate. More...
 
float basalMetabolicRate
 Advanced data - Basal Metabolic Rate. More...
 
float bodyFatPercent
 Advanced data - body fat percentage. More...
 
float bodyWeight
 Measured body weight (in kg). More...
 
float boneMass
 Advanced data - bone mass (in kg). More...
 
WFCommonDatacommonData
 Common sensor data, provides information about the sensor. More...
 
BOOL hasAntFS
 Is the scale capable of ANT FS data exchange. More...
 
BOOL hasDisplayExchangeProfile
 Is the display capable of exchanging user profile data. More...
 
BOOL hasScaleExchangeProfile
 Is the scale capable of exchanging user profile data. More...
 
float hydrationPercent
 Advanced data - body hydration percentage. More...
 
BOOL isDataStale
 TRUE if data is considered stale, otherwise FALSE. More...
 
BOOL isUserProfileSelected
 Has the user profile been selected. More...
 
float muscleMass
 Advanced data - muscle mass (in kg). More...
 
WFConnectorSettingssettings
 Gets the persistent settings for the Wahoo API. More...
 
WFWeightScaleUserProfile_t userProfile
 User profile data. More...
 
USHORT userProfileId
 User profile ID number. More...
 

Detailed Description

Represents the data available from the ANT+ Weight Scale sensor.

ANT+ sensors send data in multiple packets. The WFWeightScaleData combines this data into a single entity. The data represents the latest of each data type sent from the sensor.

Method Documentation

- (NSString*) formattedWeight: (BOOL showUnits

Property Documentation

- (float) activeMetabolicRate
readwritenonatomicassign

Advanced data - Active metabolic Rate.

Note
Two special values exist. When the weight scale is computing the user's measurements, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the metabolic rate, in kilocalories.
- (float) basalMetabolicRate
readwritenonatomicassign

Advanced data - Basal Metabolic Rate.

Note
Two special values exist. When the weight scale is computing the user's measurements, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the metabolic rate, in kilocalories.
- (float) bodyFatPercent
readwritenonatomicassign

Advanced data - body fat percentage.

Note
Two special values exist. When the weight scale is computing the user's measurements, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the body fat percentage.
- (float) bodyWeight
readwritenonatomicassigninherited

Measured body weight (in kg).

Note
Two special values exist. When the weight scale is computing the user's weight, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the weight in kilograms.
- (float) boneMass
readwritenonatomicassign

Advanced data - bone mass (in kg).

Note
Two special values exist. When the weight scale is computing the user's measurements, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the bone mass, in kg.
- (WFCommonData*) commonData
readnonatomicassign

Common sensor data, provides information about the sensor.

- (BOOL) hasAntFS
readwritenonatomicassign

Is the scale capable of ANT FS data exchange.

- (BOOL) hasDisplayExchangeProfile
readwritenonatomicassign

Is the display capable of exchanging user profile data.

- (BOOL) hasScaleExchangeProfile
readwritenonatomicassign

Is the scale capable of exchanging user profile data.

- (float) hydrationPercent
readwritenonatomicassign

Advanced data - body hydration percentage.

Note
Two special values exist. When the weight scale is computing the user's measurements, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the body hydration percentage.
- (BOOL) isDataStale
readnonatomicassigninherited

TRUE if data is considered stale, otherwise FALSE.

- (BOOL) isUserProfileSelected
readwritenonatomicassign

Has the user profile been selected.

- (float) muscleMass
readwritenonatomicassign

Advanced data - muscle mass (in kg).

Note
Two special values exist. When the weight scale is computing the user's measurements, the value will be WF_WEIGHT_SCALE_COMPUTING. If the weight scale has not recorded a valid value, the value will be WF_WEIGHT_SCALE_INVALID. Otherwise, the value is the muscle mass, in kg.
- (WFConnectorSettings*) settings
readnonatomicassigninherited

Gets the persistent settings for the Wahoo API.

- (WFWeightScaleUserProfile_t) userProfile
readwritenonatomicassign

User profile data.

- (USHORT) userProfileId
readwritenonatomicassigninherited

User profile ID number.