Class MoveRelative

Namespace

Harp.StepperDriver

Assembly

Harp.StepperDriver.dll

Represents a register 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 MoveRelative

Inheritance

object

MoveRelative

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

public const int Address = 80

Field Value

int

RegisterLength

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

public const int RegisterLength = 4

Field Value

int

RegisterType

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

public const PayloadType RegisterType = S32

Field Value

PayloadType

Methods

FromPayload(MessageType, MoveRelativePayload)

Returns a Harp message for the MoveRelative register.

public static HarpMessage FromPayload(MessageType messageType, MoveRelativePayload value)

Parameters

messageType MessageType

The type of the Harp message.

value MoveRelativePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, MoveRelativePayload)

Returns a timestamped Harp message for the MoveRelative register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value MoveRelativePayload

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for MoveRelative register messages.

public static MoveRelativePayload GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

MoveRelativePayload

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for MoveRelative register messages.

public static Timestamped<MoveRelativePayload> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<MoveRelativePayload>

A value representing the timestamped message payload.