QtFit
0.1
Internal library development documentation
|
The DeviceSettingsMessage class represents a FIT DeviceSettingsMessage data message. More...
Public Member Functions | |
DeviceSettingsMessage () | |
Constructs a DeviceSettingsMessage object. More... | |
quint8 | activeTimeZone () const |
Returns the DeviceSettingsMessage data message's activeTimeZone field's current value. More... | |
quint32 | utcOffset () const |
Returns the DeviceSettingsMessage data message's utcOffset field's current value. More... | |
quint32 | timeOffset () const |
Returns the DeviceSettingsMessage data message's timeOffset field's current value. More... | |
TimeMode | timeMode () const |
Returns the DeviceSettingsMessage data message's timeMode field's current value. More... | |
qint8 | timeZoneOffset () const |
Returns the DeviceSettingsMessage data message's timeZoneOffset field's current value. More... | |
BacklightMode | backlightMode () const |
Returns the DeviceSettingsMessage data message's backlightMode field's current value. More... | |
bool | activityTrackerEnabled () const |
Returns the DeviceSettingsMessage data message's activityTrackerEnabled field's current value. More... | |
DateTime | clockTime () const |
Returns the DeviceSettingsMessage data message's clockTime field's current value. More... | |
quint16 | pagesEnabled () const |
Returns the DeviceSettingsMessage data message's pagesEnabled field's current value. More... | |
bool | moveAlertEnabled () const |
Returns the DeviceSettingsMessage data message's moveAlertEnabled field's current value. More... | |
DateMode | dateMode () const |
Returns the DeviceSettingsMessage data message's dateMode field's current value. More... | |
DisplayOrientation | displayOrientation () const |
Returns the DeviceSettingsMessage data message's displayOrientation field's current value. More... | |
Side | mountingSide () const |
Returns the DeviceSettingsMessage data message's mountingSide field's current value. More... | |
quint16 | defaultPage () const |
Returns the DeviceSettingsMessage data message's defaultPage field's current value. More... | |
quint16 | autosyncMinSteps () const |
Returns the DeviceSettingsMessage data message's autosyncMinSteps field's current value. More... | |
quint16 | autosyncMinTime () const |
Returns the DeviceSettingsMessage data message's autosyncMinTime field's current value. More... | |
bool | lactateThresholdAutodetectEnabled () const |
Returns the DeviceSettingsMessage data message's lactateThresholdAutodetectEnabled field's current value. More... | |
bool | bleAutoUploadEnabled () const |
Returns the DeviceSettingsMessage data message's bleAutoUploadEnabled field's current value. More... | |
AutoSyncFrequency | autoSyncFrequency () const |
Returns the DeviceSettingsMessage data message's autoSyncFrequency field's current value. More... | |
AutoActivityDetect | autoActivityDetect () const |
Returns the DeviceSettingsMessage data message's autoActivityDetect field's current value. More... | |
quint8 | numberOfScreens () const |
Returns the DeviceSettingsMessage data message's numberOfScreens field's current value. More... | |
DisplayOrientation | smartNotificationDisplayOrientation () const |
Returns the DeviceSettingsMessage data message's smartNotificationDisplayOrientation field's current value. More... | |
Switch | tapInterface () const |
Returns the DeviceSettingsMessage data message's tapInterface field's current value. More... | |
TapSensitivity | tapSensitivity () const |
Returns the DeviceSettingsMessage data message's tapSensitivity field's current value. More... | |
void | setActiveTimeZone (const quint8 activeTimeZone) |
Sets the activeTimeZone field to activeTimeZone. More... | |
void | setUtcOffset (const quint32 utcOffset) |
Sets the utcOffset field to utcOffset. More... | |
void | setTimeOffset (const quint32 timeOffset) |
Sets the timeOffset field to timeOffset. More... | |
void | setTimeMode (const TimeMode timeMode) |
Sets the timeMode field to timeMode. More... | |
void | setTimeZoneOffset (const qint8 timeZoneOffset) |
Sets the timeZoneOffset field to timeZoneOffset. More... | |
void | setBacklightMode (const BacklightMode backlightMode) |
Sets the backlightMode field to backlightMode. More... | |
void | setActivityTrackerEnabled (const bool activityTrackerEnabled) |
Sets the activityTrackerEnabled field to activityTrackerEnabled. More... | |
void | setClockTime (const DateTime clockTime) |
Sets the clockTime field to clockTime. More... | |
void | setPagesEnabled (const quint16 pagesEnabled) |
Sets the pagesEnabled field to pagesEnabled. More... | |
void | setMoveAlertEnabled (const bool moveAlertEnabled) |
Sets the moveAlertEnabled field to moveAlertEnabled. More... | |
void | setDateMode (const DateMode dateMode) |
Sets the dateMode field to dateMode. More... | |
void | setDisplayOrientation (const DisplayOrientation displayOrientation) |
Sets the displayOrientation field to displayOrientation. More... | |
void | setMountingSide (const Side mountingSide) |
Sets the mountingSide field to mountingSide. More... | |
void | setDefaultPage (const quint16 defaultPage) |
Sets the defaultPage field to defaultPage. More... | |
void | setAutosyncMinSteps (const quint16 autosyncMinSteps) |
Sets the autosyncMinSteps field to autosyncMinSteps. More... | |
void | setAutosyncMinTime (const quint16 autosyncMinTime) |
Sets the autosyncMinTime field to autosyncMinTime. More... | |
void | setLactateThresholdAutodetectEnabled (const bool lactateThresholdAutodetectEnabled) |
Sets the lactateThresholdAutodetectEnabled field to lactateThresholdAutodetectEnabled. More... | |
void | setBleAutoUploadEnabled (const bool bleAutoUploadEnabled) |
Sets the bleAutoUploadEnabled field to bleAutoUploadEnabled. More... | |
void | setAutoSyncFrequency (const AutoSyncFrequency autoSyncFrequency) |
Sets the autoSyncFrequency field to autoSyncFrequency. More... | |
void | setAutoActivityDetect (const AutoActivityDetect autoActivityDetect) |
Sets the autoActivityDetect field to autoActivityDetect. More... | |
void | setNumberOfScreens (const quint8 numberOfScreens) |
Sets the numberOfScreens field to numberOfScreens. More... | |
void | setSmartNotificationDisplayOrientation (const DisplayOrientation smartNotificationDisplayOrientation) |
Sets the smartNotificationDisplayOrientation field to smartNotificationDisplayOrientation. More... | |
void | setTapInterface (const Switch tapInterface) |
Sets the tapInterface field to tapInterface. More... | |
void | setTapSensitivity (const TapSensitivity tapSensitivity) |
Sets the tapSensitivity field to tapSensitivity. More... | |
![]() | |
~AbstractDataMessage () | |
Destroys the AbstractDataMessage object. | |
MesgNum | globalMessageNumber () const |
Returns the data message's global message number. More... | |
Protected Member Functions | |
DeviceSettingsMessage (DeviceSettingsMessagePrivate *const d) | |
![]() | |
AbstractDataMessage (AbstractDataMessagePrivate *const d) | |
Additional Inherited Members | |
![]() | |
static AbstractDataMessage * | fromData (const DataDefinition *const defn, const QByteArray &record) |
Constructs the relevant AbstractDataMessage-derived class to parse record according to defn. More... | |
![]() | |
AbstractDataMessagePrivate *const | d_ptr |
Internal d-pointer. | |
The DeviceSettingsMessage class represents a FIT DeviceSettingsMessage data message.
Definition at line 39 of file devicesettingsmessage.h.
DeviceSettingsMessage::DeviceSettingsMessage | ( | ) |
Constructs a DeviceSettingsMessage object.
Typically, instances of this class will be returned by FitStreamReader::readNext, but this constructor may be used, along with the relevant setter methods, to create a valid message.
Definition at line 52 of file devicesettingsmessage.cpp.
|
explicitprotected |
Constructs a DeviceSettingsMessage object with private implementation d.
d | Pointer to private implementation. |
Definition at line 64 of file devicesettingsmessage.cpp.
quint8 DeviceSettingsMessage::activeTimeZone | ( | ) | const |
Returns the DeviceSettingsMessage data message's activeTimeZone
field's current value.
Index into time zone arrays.
activeTimeZone
field value. Definition at line 76 of file devicesettingsmessage.cpp.
Referenced by setActiveTimeZone().
bool DeviceSettingsMessage::activityTrackerEnabled | ( | ) | const |
Returns the DeviceSettingsMessage data message's activityTrackerEnabled
field's current value.
Enabled state of the activity tracker functionality
activityTrackerEnabled
field value. Definition at line 154 of file devicesettingsmessage.cpp.
Referenced by setActivityTrackerEnabled().
AutoActivityDetect DeviceSettingsMessage::autoActivityDetect | ( | ) | const |
Returns the DeviceSettingsMessage data message's autoActivityDetect
field's current value.
Allows setting specific activities auto-activity detect enabled/disabled settings
autoActivityDetect
field value. Definition at line 319 of file devicesettingsmessage.cpp.
Referenced by setAutoActivityDetect().
AutoSyncFrequency DeviceSettingsMessage::autoSyncFrequency | ( | ) | const |
Returns the DeviceSettingsMessage data message's autoSyncFrequency
field's current value.
Helps to conserve battery by changing modes
autoSyncFrequency
field value. Definition at line 306 of file devicesettingsmessage.cpp.
Referenced by setAutoSyncFrequency().
quint16 DeviceSettingsMessage::autosyncMinSteps | ( | ) | const |
Returns the DeviceSettingsMessage data message's autosyncMinSteps
field's current value.
Minimum steps before an autosync can occur
autosyncMinSteps
field value. Definition at line 254 of file devicesettingsmessage.cpp.
Referenced by setAutosyncMinSteps().
quint16 DeviceSettingsMessage::autosyncMinTime | ( | ) | const |
Returns the DeviceSettingsMessage data message's autosyncMinTime
field's current value.
Minimum minutes before an autosync can occur
autosyncMinTime
field value. Definition at line 267 of file devicesettingsmessage.cpp.
Referenced by setAutosyncMinTime().
BacklightMode DeviceSettingsMessage::backlightMode | ( | ) | const |
Returns the DeviceSettingsMessage data message's backlightMode
field's current value.
Mode for backlight
backlightMode
field value. Definition at line 141 of file devicesettingsmessage.cpp.
Referenced by setBacklightMode().
bool DeviceSettingsMessage::bleAutoUploadEnabled | ( | ) | const |
Returns the DeviceSettingsMessage data message's bleAutoUploadEnabled
field's current value.
Automatically upload using BLE
bleAutoUploadEnabled
field value. Definition at line 293 of file devicesettingsmessage.cpp.
Referenced by setBleAutoUploadEnabled().
DateTime DeviceSettingsMessage::clockTime | ( | ) | const |
Returns the DeviceSettingsMessage data message's clockTime
field's current value.
UTC timestamp used to set the devices clock and date
clockTime
field value. Definition at line 167 of file devicesettingsmessage.cpp.
Referenced by setClockTime().
DateMode DeviceSettingsMessage::dateMode | ( | ) | const |
Returns the DeviceSettingsMessage data message's dateMode
field's current value.
Display mode for the date
dateMode
field value. Definition at line 206 of file devicesettingsmessage.cpp.
Referenced by setDateMode().
quint16 DeviceSettingsMessage::defaultPage | ( | ) | const |
Returns the DeviceSettingsMessage data message's defaultPage
field's current value.
Bitfield to indicate one page as default for each supported loop
defaultPage
field value. Definition at line 241 of file devicesettingsmessage.cpp.
Referenced by setDefaultPage().
DisplayOrientation DeviceSettingsMessage::displayOrientation | ( | ) | const |
Returns the DeviceSettingsMessage data message's displayOrientation
field's current value.
displayOrientation
field value. Definition at line 217 of file devicesettingsmessage.cpp.
Referenced by setDisplayOrientation().
bool DeviceSettingsMessage::lactateThresholdAutodetectEnabled | ( | ) | const |
Returns the DeviceSettingsMessage data message's lactateThresholdAutodetectEnabled
field's current value.
Enable auto-detect setting for the lactate threshold feature.
lactateThresholdAutodetectEnabled
field value. Definition at line 280 of file devicesettingsmessage.cpp.
Referenced by setLactateThresholdAutodetectEnabled().
Side DeviceSettingsMessage::mountingSide | ( | ) | const |
Returns the DeviceSettingsMessage data message's mountingSide
field's current value.
mountingSide
field value. Definition at line 228 of file devicesettingsmessage.cpp.
Referenced by setMountingSide().
bool DeviceSettingsMessage::moveAlertEnabled | ( | ) | const |
Returns the DeviceSettingsMessage data message's moveAlertEnabled
field's current value.
Enabled state of the move alert
moveAlertEnabled
field value. Definition at line 193 of file devicesettingsmessage.cpp.
Referenced by setMoveAlertEnabled().
quint8 DeviceSettingsMessage::numberOfScreens | ( | ) | const |
Returns the DeviceSettingsMessage data message's numberOfScreens
field's current value.
Number of screens configured to display
numberOfScreens
field value. Definition at line 332 of file devicesettingsmessage.cpp.
Referenced by setNumberOfScreens().
quint16 DeviceSettingsMessage::pagesEnabled | ( | ) | const |
Returns the DeviceSettingsMessage data message's pagesEnabled
field's current value.
Bitfield to configure enabled screens for each supported loop
pagesEnabled
field value. Definition at line 180 of file devicesettingsmessage.cpp.
Referenced by setPagesEnabled().
void DeviceSettingsMessage::setActiveTimeZone | ( | const quint8 | activeTimeZone | ) |
Sets the activeTimeZone
field to activeTimeZone.
activeTimeZone | The field value to set. |
Definition at line 380 of file devicesettingsmessage.cpp.
References activeTimeZone().
void DeviceSettingsMessage::setActivityTrackerEnabled | ( | const bool | activityTrackerEnabled | ) |
Sets the activityTrackerEnabled
field to activityTrackerEnabled.
activityTrackerEnabled | The field value to set. |
Definition at line 440 of file devicesettingsmessage.cpp.
References activityTrackerEnabled().
void DeviceSettingsMessage::setAutoActivityDetect | ( | const AutoActivityDetect | autoActivityDetect | ) |
Sets the autoActivityDetect
field to autoActivityDetect.
autoActivityDetect | The field value to set. |
Definition at line 570 of file devicesettingsmessage.cpp.
References autoActivityDetect().
void DeviceSettingsMessage::setAutoSyncFrequency | ( | const AutoSyncFrequency | autoSyncFrequency | ) |
Sets the autoSyncFrequency
field to autoSyncFrequency.
autoSyncFrequency | The field value to set. |
Definition at line 560 of file devicesettingsmessage.cpp.
References autoSyncFrequency().
void DeviceSettingsMessage::setAutosyncMinSteps | ( | const quint16 | autosyncMinSteps | ) |
Sets the autosyncMinSteps
field to autosyncMinSteps.
autosyncMinSteps | The field value to set. |
Definition at line 520 of file devicesettingsmessage.cpp.
References autosyncMinSteps().
void DeviceSettingsMessage::setAutosyncMinTime | ( | const quint16 | autosyncMinTime | ) |
Sets the autosyncMinTime
field to autosyncMinTime.
autosyncMinTime | The field value to set. |
Definition at line 530 of file devicesettingsmessage.cpp.
References autosyncMinTime().
void DeviceSettingsMessage::setBacklightMode | ( | const BacklightMode | backlightMode | ) |
Sets the backlightMode
field to backlightMode.
backlightMode | The field value to set. |
Definition at line 430 of file devicesettingsmessage.cpp.
References backlightMode().
void DeviceSettingsMessage::setBleAutoUploadEnabled | ( | const bool | bleAutoUploadEnabled | ) |
Sets the bleAutoUploadEnabled
field to bleAutoUploadEnabled.
bleAutoUploadEnabled | The field value to set. |
Definition at line 550 of file devicesettingsmessage.cpp.
References bleAutoUploadEnabled().
void DeviceSettingsMessage::setClockTime | ( | const DateTime | clockTime | ) |
Sets the clockTime
field to clockTime.
clockTime | The field value to set. |
Definition at line 450 of file devicesettingsmessage.cpp.
References clockTime().
void DeviceSettingsMessage::setDateMode | ( | const DateMode | dateMode | ) |
Sets the dateMode
field to dateMode.
dateMode | The field value to set. |
Definition at line 480 of file devicesettingsmessage.cpp.
References dateMode().
void DeviceSettingsMessage::setDefaultPage | ( | const quint16 | defaultPage | ) |
Sets the defaultPage
field to defaultPage.
defaultPage | The field value to set. |
Definition at line 510 of file devicesettingsmessage.cpp.
References defaultPage().
void DeviceSettingsMessage::setDisplayOrientation | ( | const DisplayOrientation | displayOrientation | ) |
Sets the displayOrientation
field to displayOrientation.
displayOrientation | The field value to set. |
Definition at line 490 of file devicesettingsmessage.cpp.
References displayOrientation().
void DeviceSettingsMessage::setLactateThresholdAutodetectEnabled | ( | const bool | lactateThresholdAutodetectEnabled | ) |
Sets the lactateThresholdAutodetectEnabled
field to lactateThresholdAutodetectEnabled.
lactateThresholdAutodetectEnabled | The field value to set. |
Definition at line 540 of file devicesettingsmessage.cpp.
References lactateThresholdAutodetectEnabled().
void DeviceSettingsMessage::setMountingSide | ( | const Side | mountingSide | ) |
Sets the mountingSide
field to mountingSide.
mountingSide | The field value to set. |
Definition at line 500 of file devicesettingsmessage.cpp.
References mountingSide().
void DeviceSettingsMessage::setMoveAlertEnabled | ( | const bool | moveAlertEnabled | ) |
Sets the moveAlertEnabled
field to moveAlertEnabled.
moveAlertEnabled | The field value to set. |
Definition at line 470 of file devicesettingsmessage.cpp.
References moveAlertEnabled().
void DeviceSettingsMessage::setNumberOfScreens | ( | const quint8 | numberOfScreens | ) |
Sets the numberOfScreens
field to numberOfScreens.
numberOfScreens | The field value to set. |
Definition at line 580 of file devicesettingsmessage.cpp.
References numberOfScreens().
void DeviceSettingsMessage::setPagesEnabled | ( | const quint16 | pagesEnabled | ) |
Sets the pagesEnabled
field to pagesEnabled.
pagesEnabled | The field value to set. |
Definition at line 460 of file devicesettingsmessage.cpp.
References pagesEnabled().
void DeviceSettingsMessage::setSmartNotificationDisplayOrientation | ( | const DisplayOrientation | smartNotificationDisplayOrientation | ) |
Sets the smartNotificationDisplayOrientation
field to smartNotificationDisplayOrientation.
smartNotificationDisplayOrientation | The field value to set. |
Definition at line 590 of file devicesettingsmessage.cpp.
References smartNotificationDisplayOrientation().
void DeviceSettingsMessage::setTapInterface | ( | const Switch | tapInterface | ) |
Sets the tapInterface
field to tapInterface.
tapInterface | The field value to set. |
Definition at line 600 of file devicesettingsmessage.cpp.
References tapInterface().
void DeviceSettingsMessage::setTapSensitivity | ( | const TapSensitivity | tapSensitivity | ) |
Sets the tapSensitivity
field to tapSensitivity.
tapSensitivity | The field value to set. |
Definition at line 610 of file devicesettingsmessage.cpp.
References tapSensitivity().
void DeviceSettingsMessage::setTimeMode | ( | const TimeMode | timeMode | ) |
Sets the timeMode
field to timeMode.
timeMode | The field value to set. |
Definition at line 410 of file devicesettingsmessage.cpp.
References timeMode().
void DeviceSettingsMessage::setTimeOffset | ( | const quint32 | timeOffset | ) |
Sets the timeOffset
field to timeOffset.
timeOffset | The field value to set. |
Definition at line 400 of file devicesettingsmessage.cpp.
References timeOffset().
void DeviceSettingsMessage::setTimeZoneOffset | ( | const qint8 | timeZoneOffset | ) |
Sets the timeZoneOffset
field to timeZoneOffset.
timeZoneOffset | The field value to set. |
Definition at line 420 of file devicesettingsmessage.cpp.
References timeZoneOffset().
void DeviceSettingsMessage::setUtcOffset | ( | const quint32 | utcOffset | ) |
Sets the utcOffset
field to utcOffset.
utcOffset | The field value to set. |
Definition at line 390 of file devicesettingsmessage.cpp.
References utcOffset().
DisplayOrientation DeviceSettingsMessage::smartNotificationDisplayOrientation | ( | ) | const |
Returns the DeviceSettingsMessage data message's smartNotificationDisplayOrientation
field's current value.
Smart Notification display orientation
smartNotificationDisplayOrientation
field value. Definition at line 345 of file devicesettingsmessage.cpp.
Referenced by setSmartNotificationDisplayOrientation().
Switch DeviceSettingsMessage::tapInterface | ( | ) | const |
Returns the DeviceSettingsMessage data message's tapInterface
field's current value.
tapInterface
field value. Definition at line 356 of file devicesettingsmessage.cpp.
Referenced by setTapInterface().
TapSensitivity DeviceSettingsMessage::tapSensitivity | ( | ) | const |
Returns the DeviceSettingsMessage data message's tapSensitivity
field's current value.
Used to hold the tap threshold setting
tapSensitivity
field value. Definition at line 369 of file devicesettingsmessage.cpp.
Referenced by setTapSensitivity().
TimeMode DeviceSettingsMessage::timeMode | ( | ) | const |
Returns the DeviceSettingsMessage data message's timeMode
field's current value.
Display mode for the time
timeMode
field value. Definition at line 115 of file devicesettingsmessage.cpp.
Referenced by setTimeMode().
quint32 DeviceSettingsMessage::timeOffset | ( | ) | const |
Returns the DeviceSettingsMessage data message's timeOffset
field's current value.
Offset from system time.
timeOffset
field value. Definition at line 102 of file devicesettingsmessage.cpp.
Referenced by setTimeOffset().
qint8 DeviceSettingsMessage::timeZoneOffset | ( | ) | const |
Returns the DeviceSettingsMessage data message's timeZoneOffset
field's current value.
timezone offset in 1/4 hour increments
timeZoneOffset
field value. Definition at line 128 of file devicesettingsmessage.cpp.
Referenced by setTimeZoneOffset().
quint32 DeviceSettingsMessage::utcOffset | ( | ) | const |
Returns the DeviceSettingsMessage data message's utcOffset
field's current value.
Offset from system time. Required to convert timestamp from system time to UTC.
utcOffset
field value. Definition at line 89 of file devicesettingsmessage.cpp.
Referenced by setUtcOffset().