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
WFFitFileInfo Class Reference

Represents file structure information for the FIT file system. More...

#import <WFFitFileInfo.h>

+ Inheritance diagram for WFFitFileInfo:
+ Collaboration diagram for WFFitFileInfo:

Instance Methods

(NSString *) - stringFromTimestamp
 Returns the timestamp as a string formatted in short date time (MM/DD/YY 12:00 AM). More...
 

Properties

NSDate * timestamp
 Gets or sets the time the file was created. More...
 
UCHAR ucFileDataType
 Gets or sets the data type of the file. More...
 
UCHAR ucFileSubType
 Gets or sets the data sub-type of the .FIT file. More...
 
UCHAR ucGeneralFlags
 Gets or sets the bit-mapped flags of file permissions. More...
 
UCHAR ucSpecificFlags
 Gets or sets the bit-mapped flags of the data type specific permissions. More...
 
ULONG ulFileSize
 Gets or sets the size of the file in bytes. More...
 
USHORT usFileIndex
 Gets or sets the data file index. More...
 
USHORT usFileNumber
 Gets or sets the number used to identify a specific instance of a file sub-type. More...
 

Detailed Description

Represents file structure information for the FIT file system.

Method Documentation

- (NSString*) stringFromTimestamp

Returns the timestamp as a string formatted in short date time (MM/DD/YY 12:00 AM).

Returns
The formatted date string (MM/DD/YY 12:00 AM).

Property Documentation

- (NSDate*) timestamp
readwritenonatomicretain

Gets or sets the time the file was created.

- (UCHAR) ucFileDataType
readwritenonatomicassign

Gets or sets the data type of the file.

The File Data Type informs the host how the file may be interpreted.

- (UCHAR) ucFileSubType
readwritenonatomicassign

Gets or sets the data sub-type of the .FIT file.

- (UCHAR) ucGeneralFlags
readwritenonatomicassign

Gets or sets the bit-mapped flags of file permissions.

Bit 0-2: Reserved.
Bit 3: Append (can append to file only).
Bit 4: Archive (has been downloaded).
Bit 5: Erase (can be erased).
Bit 6: Write (can upload).
BIt 7: Read (can download).

- (UCHAR) ucSpecificFlags
readwritenonatomicassign

Gets or sets the bit-mapped flags of the data type specific permissions.

Only bit 0 is used at this time, all others are reserved for future use. Bit 0 specifies whether the file is selected by the user.

- (ULONG) ulFileSize
readwritenonatomicassign

Gets or sets the size of the file in bytes.

If file size is zero, then the file has not been uploaded, but may be available for upload.

- (USHORT) usFileIndex
readwritenonatomicassign

Gets or sets the data file index.

This is the value used when referencing files for download, upload, and erase.

- (USHORT) usFileNumber
readwritenonatomicassign

Gets or sets the number used to identify a specific instance of a file sub-type.

Can refer to user, session number, etc.