Class AnalogData

Namespace

Harp.AnalogInput

Assembly

Harp.AnalogInput.dll

Represents a register that value from a single read of all ADC channels.

public class AnalogData

Inheritance

object

AnalogData

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

public const int Address = 33

Field Value

int

RegisterLength

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

public const int RegisterLength = 4

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S16

Field Value

PayloadType

Methods

FromPayload(MessageType, AnalogDataPayload)

Returns a Harp message for the AnalogData register.

public static HarpMessage FromPayload(MessageType messageType, AnalogDataPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value AnalogDataPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, AnalogDataPayload)

Returns a timestamped Harp message for the AnalogData register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value AnalogDataPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for AnalogData register messages.

public static AnalogDataPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

AnalogDataPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for AnalogData register messages.

public static Timestamped<AnalogDataPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<AnalogDataPayload>

A value representing the timestamped message payload.