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
WFHardwareConnector(AntFS) Category Reference

A category on the WFHardwareConnector class which facilitates communications with devices which use ANT FS to transfer data. More...

#import <WFHardwareConnector+AntFS.h>

Instance Methods

(BOOL- releaseAntFSDevice:
 Releases resources used by the specified WFAntFSDevice. More...
 
(BOOL- requestAntFSDevice:toDelegate:
 Requests that a WFAntFSDevice instance be created and initialized. More...
 

Detailed Description

A category on the WFHardwareConnector class which facilitates communications with devices which use ANT FS to transfer data.

Method Documentation

- (BOOL) releaseAntFSDevice: (WFAntFSDevice *)  fsDevice

Releases resources used by the specified WFAntFSDevice.

Note
The WFAntFSDevice requires resources which are allocated and maintained by the Wahoo Fitness API. Instances should be created via the requestAntFSDevice:toDelegate: method, and released via this method. Please do not invoke the NSObject::release directly on the WFAntFSDevice instance. Doing so will not properly release all resources used by the API during the life of the WFAntFSDevice instance.

It is best not to retain the WFAntFSDevice instance, but rather to use assignment when passing a reference. If retain must be used, take care to use a corresponding release to ensure that the retain count returns to one, and not below before invoking this method.
Parameters
fsDeviceThe WFAntFSDevice instance to be released.
Returns
TRUE if resources were released successfully, otherwise FALSE.

Extends class WFHardwareConnector.

- (BOOL) requestAntFSDevice: (WFAntFSDeviceType_t deviceType
toDelegate: (id< WFAntFSDeviceDelegate >)  theDelegate 

Requests that a WFAntFSDevice instance be created and initialized.

Note
The ANT file manager requires resources which are allocated and maintained by the Wahoo Fitness API. Please be sure to invoke the releaseAntFSDevice: method to release resources when the instance is no longer needed. Failing to do this will result in a memory leak.
Parameters
deviceTypeThe type of device for which the WFAntFSDevice is to be created. ANT FS profiles are different among device types, the specific type of ANT FS Device created will be the type which is able to process files for the specified device type.
theDelegateThe delegate which will be alerted when the ANT FS Device instance is ready. The ANT FS Device creation is an asynchronous operation. This method will return immediately, and the delegate method will be invoked when the operation is complete (see the note on the WFAntFSDevice::delegate property for more details).
Returns
TRUE if the ANT FS Device creation operation is started successfully, otherwise FALSE.

Extends class WFHardwareConnector.