AntRadioGetDeviceCapabilities Method

Gets the device capabilities of the ANT radio.

Definition

Namespace: SmallEarthTech.AntUsbStick
Assembly: SmallEarthTech.AntUsbStick (in SmallEarthTech.AntUsbStick.dll) Version: 3.0.0.0+01fc5ca24e8f030354f28ec9cef320bc5cbb0ef6

C#

public Task<DeviceCapabilities> GetDeviceCapabilities(
	bool forceNewCopy = false,
	uint responseWaitTime = 1500
)

VB

Public Function GetDeviceCapabilities ( 
	Optional forceNewCopy As Boolean = false,
	Optional responseWaitTime As UInteger = 1500
) As Task(Of DeviceCapabilities)

C++

public:
virtual Task<DeviceCapabilities^>^ GetDeviceCapabilities(
	bool forceNewCopy = false, 
	unsigned int responseWaitTime = 1500
) sealed

F#

abstract GetDeviceCapabilities : 
        ?forceNewCopy : bool * 
        ?responseWaitTime : uint32 
(* Defaults:
        let _forceNewCopy = defaultArg forceNewCopy false
        let _responseWaitTime = defaultArg responseWaitTime 1500
*)
-> Task<DeviceCapabilities> 
override 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

TaskDeviceCapabilities
A task encapsulating the DeviceCapabilities

Implements

IAntRadioGetDeviceCapabilities(Boolean, UInt32)

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).