Class MagneticEncoder

Namespace

Harp.OutputExpander

Assembly

Harp.OutputExpander.dll

Represents a register that generated event with the latest read from the magnetic encoder.

public class MagneticEncoder

Inheritance

object

MagneticEncoder

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

public const int Address = 90

Field Value

int

RegisterLength

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

public const int RegisterLength = 2

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U16

Field Value

PayloadType

Methods

FromPayload(MessageType, MagneticEncoderPayload)

Returns a Harp message for the MagneticEncoder register.

public static HarpMessage FromPayload(MessageType messageType, MagneticEncoderPayload value)

Parameters

messageType MessageType

The type of the Harp message.

value MagneticEncoderPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, MagneticEncoderPayload)

Returns a timestamped Harp message for the MagneticEncoder register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value MagneticEncoderPayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MagneticEncoder register messages.

public static MagneticEncoderPayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

MagneticEncoderPayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MagneticEncoder register messages.

public static Timestamped<MagneticEncoderPayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<MagneticEncoderPayload>

A value representing the timestamped message payload.