Class CreateAccumulatedStepsPayload

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents an operator that creates a message payload that contains the accumulated steps of all motors. Write a value to set the accumulated steps. An event will be emitted with a dispatch rate defined in AccumulatedStepsSamplingRate.

public class CreateAccumulatedStepsPayload

Inheritance

object

CreateAccumulatedStepsPayload

Derived

CreateTimestampedAccumulatedStepsPayload

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Motor0

Gets or sets a value that contains the accumulated steps of motor 0.

public int Motor0 { get; set; }

Property Value

int

Motor1

Gets or sets a value that contains the accumulated steps of motor 1.

public int Motor1 { get; set; }

Property Value

int

Motor2

Gets or sets a value that contains the accumulated steps of motor 2.

public int Motor2 { get; set; }

Property Value

int

Motor3

Gets or sets a value that contains the accumulated steps of motor 3.

public int Motor3 { get; set; }

Property Value

int

Methods

GetMessage(MessageType)

Creates a message that contains the accumulated steps of all motors. Write a value to set the accumulated steps. An event will be emitted with a dispatch rate defined in AccumulatedStepsSamplingRate.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the AccumulatedSteps register.

GetPayload()

Creates a message payload for the AccumulatedSteps register.

public AccumulatedStepsPayload GetPayload()

Returns

AccumulatedStepsPayload

The created message payload value.