Table of Contents

Method ReadTimestampedPulseTrainGP21Async

Namespace
Harp.Hobgoblin
Assembly
Harp.Hobgoblin.dll

ReadTimestampedPulseTrainGP21Async(CancellationToken)

Asynchronously reads the timestamped payload of the PulseTrainGP21 register.

public Task<Timestamped<PulseTrainGP21Payload>> ReadTimestampedPulseTrainGP21Async(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task<Timestamped<PulseTrainGP21Payload>>

A task that represents the asynchronous read operation. The value of its Result property contains the timestamped register payload.

Exceptions

HarpException

The device replied to the read request with an error. This exception is stored into the returned task.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.