Class ConfigureAdc

Namespace

Harp.SoundCard

Assembly

Harp.SoundCard.dll

Represents a register that configuration of Analog Inputs.

public class ConfigureAdc

Inheritance

object

ConfigureAdc

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

public const int Address = 80

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, AdcConfiguration)

Returns a Harp message for the ConfigureAdc register.

public static HarpMessage FromPayload(MessageType messageType, AdcConfiguration value)

Parameters

messageType MessageType

The type of the Harp message.

value AdcConfiguration

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, AdcConfiguration)

Returns a timestamped Harp message for the ConfigureAdc register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value AdcConfiguration

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for ConfigureAdc register messages.

public static AdcConfiguration GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

AdcConfiguration

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for ConfigureAdc register messages.

public static Timestamped<AdcConfiguration> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<AdcConfiguration>

A value representing the timestamped message payload.