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

Represents the connection parameters used to establish a connection to an ANT device. More...

#import <WFConnectionParams.h>

+ Inheritance diagram for WFConnectionParams:
+ Collaboration diagram for WFConnectionParams:

Instance Methods

(BOOL- hasDeviceNumber:
 Returns a boolean value indicating whether the specified device ID is specified in any of the device parameters. More...
 
(BOOL- hasDeviceUUID:
 Returns a boolean value indicating whether the specified device UUID is specified in any of the device parameters. More...
 

Properties

WFComparisonType_t conditionalComparisonType
 Specifies the type of comparison to use for conditional connection. More...
 
NSData * conditionalData
 Gets or sets the data used to determine whether a conditional connection will be established or not. More...
 
WFDeviceParamsdevice1
 The first of four possible devices to connect. More...
 
WFDeviceParamsdevice2
 The second of four possible devices to connect. More...
 
WFDeviceParamsdevice3
 The third or four possible devices to connect. More...
 
WFDeviceParamsdevice4
 The fourth of four possible devices to connect. More...
 
BOOL isConnectionConditional
 TRUE if the params specify a conditional connection, otherwise FALSE. More...
 
BOOL isWildcard
 Returns a boolean value indicating whether this WFConnectionParams is configured for a wildcard search. More...
 
WFNetworkType_t networkType
 Gets or sets the network type specified by this WFConnectionParams. More...
 
USHORT searchTimeout
 Specifies the search timeout, in seconds. More...
 
WFSensorSubType_t sensorSubType
 Specifies the specific implementation of the device to be connected. More...
 
WFSensorType_t sensorType
 Specifies the type of sensor to be connected. More...
 

Detailed Description

Represents the connection parameters used to establish a connection to an ANT device.

Up to four devices may be specified in the connection parameters. The API will search until one of the devices is found, or the timeout expires. If no devices are specified, a wildcard search is performed.

Method Documentation

- (BOOL) hasDeviceNumber: (USHORT devNumber

Returns a boolean value indicating whether the specified device ID is specified in any of the device parameters.

Parameters
devNumberThe device ID to check.
Returns
TRUE if the specified device ID is included in this WFConnectionParameters, otherwise FALSE.
- (BOOL) hasDeviceUUID: (NSString *)  uuidString

Returns a boolean value indicating whether the specified device UUID is specified in any of the device parameters.

Parameters
uuidStringThe device UUID string to check.
Returns
TRUE if the specified device UUID is included in this WFConnectionParameters, otherwise FALSE.

Property Documentation

- (WFComparisonType_t) conditionalComparisonType
readwritenonatomicassign

Specifies the type of comparison to use for conditional connection.

Note
This property is for internal use, and should not be assigned directly.
- (NSData*) conditionalData
readwritenonatomicretain

Gets or sets the data used to determine whether a conditional connection will be established or not.

Note
This property is for internal use, and should not be assigned directly.
- (WFDeviceParams*) device1
readwritenonatomicretain

The first of four possible devices to connect.

- (WFDeviceParams*) device2
readwritenonatomicretain

The second of four possible devices to connect.

- (WFDeviceParams*) device3
readwritenonatomicretain

The third or four possible devices to connect.

- (WFDeviceParams*) device4
readwritenonatomicretain

The fourth of four possible devices to connect.

- (BOOL) isConnectionConditional
readnonatomicassign

TRUE if the params specify a conditional connection, otherwise FALSE.

See also
WFConnectionParams::conditionalData
- (BOOL) isWildcard
readnonatomicassign

Returns a boolean value indicating whether this WFConnectionParams is configured for a wildcard search.

Returns
TRUE if a wildcard search is specified, otherwise FALSE.
- (WFNetworkType_t) networkType
readwritenonatomicassign

Gets or sets the network type specified by this WFConnectionParams.

Note
Setting this property is only valid in the context of a wildcard search. If any of the four WFDeviceParams (deviceX) properties are set, the value of this property is derived from the WFDeviceParams::networkType of the specified device params.
- (USHORT) searchTimeout
readwritenonatomicassign

Specifies the search timeout, in seconds.

A value of 0 disables the search timeout.

Note
When connecting to an ANT Device through the Wahoo Fitness ANT Bridge, the search timeout is capped at 5 minutes (300 seconds). Setting the search timeout to infinite (0) or greater than 300 in this case has the same effect as setting the value to 300.
See also
- enableAntBridge: (WFHardwareConnector)
WFHardwareConnector::isAntBridgeEnabled
- (WFSensorSubType_t) sensorSubType
readwritenonatomicassign

Specifies the specific implementation of the device to be connected.

This property is used for device profiles where connection to a specific sub-type is desired. For example, this property may specify connection to the Wahoo KICKR Bike Trainer specifically, as opposed to any Bike Power Meter.

Note
This property is not applicable for all sensor types. For sensor types where the property is not applicable, the value is ignored.
- (WFSensorType_t) sensorType
readwritenonatomicassign

Specifies the type of sensor to be connected.