Table of Contents

Class CreateMagneticEncoderPayload

Namespace
Harp.OutputExpander
Assembly
Harp.OutputExpander.dll

Represents an operator that creates a message payload that generated event with the latest read from the magnetic encoder.

public class CreateMagneticEncoderPayload
Inheritance
CreateMagneticEncoderPayload
Derived
Inherited Members

Properties

Angle

Gets or sets a value that the angle position measurement of the magnetic encoder.

public ushort Angle { get; set; }

Property Value

ushort

Magnitude

Gets or sets a value that the magnitude of the magnetic field.

public ushort Magnitude { get; set; }

Property Value

ushort

Methods

GetMessage(MessageType)

Creates a message that generated event with the latest read from the magnetic encoder.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the MagneticEncoder register.

GetPayload()

Creates a message payload for the MagneticEncoder register.

public MagneticEncoderPayload GetPayload()

Returns

MagneticEncoderPayload

The created message payload value.