Class SamplingRate

Namespace

Harp.AnalogInput

Assembly

Harp.AnalogInput.dll

Represents a register that sets the sampling frequency of the ADC.

public class SamplingRate

Inheritance

object

SamplingRate

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Address

Represents the address of the SamplingRate register. This field is constant.

public const int Address = 38

Field Value

int

RegisterLength

Represents the length of the SamplingRate register. This field is constant.

public const int RegisterLength = 1

Field Value

int

RegisterType

Represents the payload type of the SamplingRate register. This field is constant.

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, SamplingRateMode)

Returns a Harp message for the SamplingRate register.

public static HarpMessage FromPayload(MessageType messageType, SamplingRateMode value)

Parameters

messageType MessageType

The type of the Harp message.

value SamplingRateMode

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the SamplingRate register with the specified message type and payload.

FromPayload(double, MessageType, SamplingRateMode)

Returns a timestamped Harp message for the SamplingRate register.

public static HarpMessage FromPayload(double timestamp, MessageType messageType, SamplingRateMode value)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value SamplingRateMode

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the SamplingRate register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for SamplingRate register messages.

public static SamplingRateMode GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

SamplingRateMode

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for SamplingRate register messages.

public static Timestamped<SamplingRateMode> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<SamplingRateMode>

A value representing the timestamped message payload.