Class RangeAndFilter

Namespace

Harp.AnalogInput

Assembly

Harp.AnalogInput.dll

Represents a register that sets the range and LowPass filter cutoff of the ADC.

public class RangeAndFilter

Inheritance

object

RangeAndFilter

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 RangeAndFilter register. This field is constant.

public const int Address = 37

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, RangeAndFilterConfig)

Returns a Harp message for the RangeAndFilter register.

public static HarpMessage FromPayload(MessageType messageType, RangeAndFilterConfig value)

Parameters

messageType MessageType

The type of the Harp message.

value RangeAndFilterConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, RangeAndFilterConfig)

Returns a timestamped Harp message for the RangeAndFilter register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value RangeAndFilterConfig

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for RangeAndFilter register messages.

public static RangeAndFilterConfig GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

RangeAndFilterConfig

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for RangeAndFilter register messages.

public static Timestamped<RangeAndFilterConfig> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<RangeAndFilterConfig>

A value representing the timestamped message payload.