Small Earth Technology ANT+ Class Library
IAnt
Gets the device capabilities of the ANT radio.
Definition
Namespace: SmallEarthTech.AntRadioInterface
Assembly: SmallEarthTech.AntRadioInterface (in SmallEarthTech.AntRadioInterface.dll) Version: 3.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5
A task encapsulating the DeviceCapabilities
Assembly: SmallEarthTech.AntRadioInterface (in SmallEarthTech.AntRadioInterface.dll) Version: 3.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5
C#
Task<DeviceCapabilities> GetDeviceCapabilities(
bool forceNewCopy = false,
uint responseWaitTime = 1500
)VB
Function GetDeviceCapabilities (
Optional forceNewCopy As Boolean = false,
Optional responseWaitTime As UInteger = 1500
) As Task(Of DeviceCapabilities)C++
Task<DeviceCapabilities^>^ GetDeviceCapabilities(
bool forceNewCopy = false,
unsigned int responseWaitTime = 1500
)F#
abstract GetDeviceCapabilities :
?forceNewCopy : bool *
?responseWaitTime : uint32
(* Defaults:
let _forceNewCopy = defaultArg forceNewCopy false
let _responseWaitTime = defaultArg responseWaitTime 1500
*)
-> Task<DeviceCapabilities> Parameters
- forceNewCopy Boolean (Optional)
- If set to true force new copy. The default is false.
- responseWaitTime UInt32 (Optional)
- The response wait time in milliseconds. The default is 1500ms.
Return Value
TaskDeviceCapabilitiesA task encapsulating the DeviceCapabilities
Remarks
Default arguments are provided by the method interface and are inherited by concrete implementations of IAntRadio.
It is unlikely the default arguments need to be overridden. Typically a copy of the DeviceCapabilities is maintained
in the concrete implementation of the ANT radio and the response wait time only needs to be overridden if there a large
latencies getting the response. Use a named argument if you only need to specify a different response wait time -
e.g. GetDeviceCapabilities(responseWaitTime: 2000).