Class CreateMoveRelativePayload

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents an operator that creates a message payload that moves all motors by the number of steps written in this array register and set the direction according to the value's signal. If a motor is disable, the user should set the value to 0.

public class CreateMoveRelativePayload

Inheritance

object

CreateMoveRelativePayload

Derived

CreateTimestampedMoveRelativePayload

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 number of steps used to move motor 0.

public int Motor0 { get; set; }

Property Value

int

Motor1

Gets or sets a value that contains the number of steps used to move motor 1.

public int Motor1 { get; set; }

Property Value

int

Motor2

Gets or sets a value that contains the number of steps used to move motor 2.

public int Motor2 { get; set; }

Property Value

int

Motor3

Gets or sets a value that contains the number of steps used to move motor 3.

public int Motor3 { get; set; }

Property Value

int

Methods

GetMessage(MessageType)

Creates a message that moves all motors by the number of steps written in this array register and set the direction according to the value's signal. If a motor is disable, the user should set the value to 0.

public HarpMessage GetMessage(MessageType messageType)

Parameters

messageType MessageType

Specifies the type of the created message.

Returns

HarpMessage

A new message for the MoveRelative register.

GetPayload()

Creates a message payload for the MoveRelative register.

public MoveRelativePayload GetPayload()

Returns

MoveRelativePayload

The created message payload value.